DeployedApiCreateInput

Input parameters for creating a new deployed API with component, authentication, plans, and environment configuration.

input DeployedApiCreateInput {
  apiComponentId: ID!
  authSourceId: String
  planIds: [ID!]
  keylessPlanId: ID
  requiredRoles: [ID!]
  environmentId: ID!
  apiVersion: String
  packageRevision: String
  branchName: String
  policyTemplates: [DeployedApiPolicyTemplatePathInput!]
}

Fields

DeployedApiCreateInput.apiComponentId ● ID! non-null scalar miscellaneous {#api-component-id}

The ID of the API component to deploy.

DeployedApiCreateInput.authSourceId ● String scalar miscellaneous {#auth-source-id}

The authentication source ID for the deployed API.

DeployedApiCreateInput.planIds ● [ID!] list scalar miscellaneous {#plan-ids}

List of plan IDs to associate with the deployed API.

DeployedApiCreateInput.keylessPlanId ● ID scalar miscellaneous {#keyless-plan-id}

The keyless plan ID for the deployed API.

DeployedApiCreateInput.requiredRoles ● [ID!] list scalar miscellaneous {#required-roles}

List of required role IDs for the deployed API.

DeployedApiCreateInput.environmentId ● ID! non-null scalar miscellaneous {#environment-id}

The environment ID where the API will be deployed.

DeployedApiCreateInput.apiVersion ● String scalar miscellaneous {#api-version}

The version of the API to deploy.

DeployedApiCreateInput.packageRevision ● String scalar miscellaneous {#package-revision}

The package revision for the API deployment.

DeployedApiCreateInput.branchName ● String scalar miscellaneous {#branch-name}

Filter branch name for the API deployment.

DeployedApiCreateInput.policyTemplates ● [DeployedApiPolicyTemplatePathInput!] list input platform {#policy-templates}

Policy templates to associate with the deployed API, each optionally specifying a path.

Member Of

deployedApiCreate mutation