DeployedApiInput

Input parameters for updating deployed API configuration.

input DeployedApiInput {
  id: ID!
  executionSettings: DeployedApiExecutionSettingsInput
  authSourceId: String
  planIds: [ID!]
  keylessPlanId: ID
  requiredRoles: [ID!]
  customPolicies: [DeployedApiPolicyInput!]
  cors: DeployedApiCorsInput
  certificateAuthentication: DeployedApiCertificateAuthenticationInput
  customPolicyPathMode: CustomPolicyPathMode
}

Fields

DeployedApiInput.id ● ID! non-null scalar miscellaneous

The ID of the deployed API.

DeployedApiInput.executionSettings ● DeployedApiExecutionSettingsInput input platform

Execution settings for the deployed API.

DeployedApiInput.authSourceId ● String scalar miscellaneous

The authentication source ID for the deployed API.

DeployedApiInput.planIds ● [ID!] list scalar miscellaneous

List of plan IDs to associate with the deployed API.

DeployedApiInput.keylessPlanId ● ID scalar miscellaneous

The keyless plan ID for the deployed API.

DeployedApiInput.requiredRoles ● [ID!] list scalar miscellaneous

List of required role IDs for the deployed API.

DeployedApiInput.customPolicies ● [DeployedApiPolicyInput!] list input platform

Custom policies to apply to the deployed API.

DeployedApiInput.cors ● DeployedApiCorsInput input platform

CORS configuration for the deployed API.

DeployedApiInput.certificateAuthentication ● DeployedApiCertificateAuthenticationInput input platform

Certificate authentication settings for the Gateway.

DeployedApiInput.customPolicyPathMode ● CustomPolicyPathMode enum platform

Custom policy path mode for a deployed API (All Match, Best Match).

Member Of

deployedApiUpdate mutation