deployedApiUpdate

Updates an existing deployed API configuration.

Input Parameters:

• deployedApi: Configuration object containing deployment settings including authentication, plans, and execution settings.

Response:

• Returns the updated DeployedApi object with all configuration details.

Example Request:

mutation {
    deployedApiUpdate(deployedApi: {
        id: "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
        customPolicies: [
            {
                path: "/",
                rules: ["<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>"],
                appliedWhen: AFTER_STANDARD_POLICIES
            }
        ]
    }) {
        id,
        customPolicies {
            path,
            when,
            rules {
            id,
            name
            }
        }
    }
}

deployedApiUpdate(
  deployedApi: DeployedApiInput!
): DeployedApi!

Arguments

deployedApiUpdate.deployedApi ● DeployedApiInput! non-null input platform

Type

DeployedApi object platform

Represents an API deployed to a specific environment and the various information associated with it (Component, ApiComponentMetadata, Environment, DeployedApiEndpoint, Keyless Plan, number of plans associated with Deployed Api, Execution Settings and required roles)