Waiting for engine...
Skip to main content

deployedApiSubscriptionUpdate

Updates an existing Subscription using it's API Key ID. Subscription's expiration date/time and status can be updated.

Input Parameters:

  • deployedApiSubscription: Updated subscription configuration including API key ID and modified fields.

Response:

  • Returns the updated DeployedApiSubscription object with modified subscription details.

Example Request:

mutation deployedApiSubscriptionUpdate($deployedApiSubscription: DeployedApiSubscriptionUpdateInput!) {
deployedApiSubscriptionUpdate(
deployedApiSubscription: $deployedApiSubscription
) {
apiKeyId,
status,
startDate,
expirationDate,
approvalDate,
consumerMessage,
producerMessage,
generatedBy,
generatedDate,
statusChangedBy,
statusChangedDate
}
}

Variables:

{
"deployedApiSubscription": {
"apiKeyId": "<xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx>",
"status": "SUSPENDED"
}
}

deployedApiSubscriptionUpdate(
deployedApiSubscription: DeployedApiSubscriptionUpdateInput!
): DeployedApiSubscription!

Arguments

deployedApiSubscriptionUpdate.deployedApiSubscription ● DeployedApiSubscriptionUpdateInput! non-null input platform

Type

DeployedApiSubscription object platform

On this Page