v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB

API Subscriptions

Update one API's subscription

Update the API's subscription.

put/environments/{envId}/apis/{apiId}/subscriptions/{subscriptionId}

Request body

metadataobject

A list of metadata associated to this subscription.

startingAtstring date-time

The datetime when the subscription starts. No starting date means the subscription starts immediately.

endingAtstring date-time

The datetime when the subscription ends. No ending date means the subscription never ends.

Example request

{
  "consumerConfiguration": {
    "entrypointId": "webhook",
    "channel": "/channel1"
  },
  "startingAt": "2023-05-20 12:30:42.101000+00:00",
  "endingAt": "2023-05-25 12:40:46.184000+00:00"
}

Response

API's subscription successfully updated

idstring

Subscription's uuid.

consumerMessagestring

Message given by the api consumer when subscribing to the api.

publisherMessagestring

Message given by the api publisher when accepting or rejecting the subscription.

metadataobject

A list of metadata associated to this subscription.

daysToExpirationOnLastNotificationinteger

Number of days before the expiration of this subscription when the last pre-expiration notification was sent.

failureCausestring

Details about the last failure encountered on this subscription.

The status of the subscription manageable by the api publisher.

consumerStatus'STARTED' | 'STOPPED' | 'FAILURE'

The status of the subscription manageable by the api consumer.

processedAtstring date-time

The datetime when the subscription was processed.

startingAtstring date-time

The datetime when the subscription starts. No starting date means the subscription starts immediately.

endingAtstring date-time

The datetime when the subscription ends. No ending date means the subscription never ends.

createdAtstring date-time

The datetime when the subscription was created.

updatedAtstring date-time

The last datetime when the subscription was updated.

closedAtstring date-time

The datetime when the subscription was closed.

pausedAtstring date-time

The datetime when the subscription was paused by the api publisher.

consumerPausedAtstring date-time

The datetime when the subscription was paused by the api consumer.

origin'KUBERNETES' | 'MANAGEMENT'

The origin of the subscription.

Example response

{
  "id": "34f8c9e7-68fd-4922-b8c9-e778fc790777",
  "api": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My Api",
    "description": "I can use many characters to describe this API."
  },
  "apiProduct": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My API Product",
    "description": "A bundle of public APIs."
  },
  "plan": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My Api plan",
    "description": "I can use a hundred characters to describe this plan.",
    "apiId": "6c530064-0b2c-4004-9300-640b2ce0047b",
    "apiProductId": "6c530064-0b2c-4004-9300-640b2ce0047b",
    "security": {
      "type": "KEY_LESS"
    },
    "mode": "STANDARD"
  },
  "application": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "name": "My App",
    "description": "I can use a hundred characters to describe this App.",
    "domain": "https://my-app.com",
    "type": "iOS",
    "primaryOwner": {
      "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "displayName": "John Doe"
    },
    "apiKeyMode": "UNSPECIFIED"
  },
  "consumerConfiguration": {
    "entrypointId": "webhook",
    "channel": "/channel1"
  },
  "status": "ACCEPTED",
  "consumerStatus": "STOPPED",
  "processedBy": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "displayName": "John Doe"
  },
  "subscribedBy": {
    "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
    "displayName": "John Doe"
  },
  "processedAt": "2023-05-18 12:40:46.184000+00:00",
  "startingAt": "2023-05-20 12:30:42.101000+00:00",
  "endingAt": "2023-05-25 12:40:46.184000+00:00",
  "createdAt": "2023-05-18 12:40:46.184000+00:00",
  "updatedAt": "2023-05-25 12:40:46.184000+00:00",
  "closedAt": "2023-05-31 13:40:46.184000+00:00",
  "pausedAt": "2023-05-25 12:40:46.184000+00:00",
  "consumerPausedAt": "2023-05-25 12:40:46.184000+00:00",
  "origin": "KUBERNETES"
}