Sign in

v2

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

Renew the subscription API Keys.

Renew the subscription API Keys.

Renew the subscription API Key by setting an expiration date on the existing active API Keys and creating a new API Key.<br> The newly created API Key is returned in response.

post/environments/{envId}/apis/{apiId}/subscriptions/{subscriptionId}/api-keys/_renew

Request body

customApiKeystring

Optional custom API Key that can be given when custom API Key support is enabled.

Response

API's subscription API Key successfully renewed

idstring

The internal UUID of the API Key.

keystring

The API Key value to use to call the protected api.

revokedboolean

Flag indicating that the API Key has been revoked.

pausedboolean

Flag indicating that the API Key has been paused.

expiredboolean

Flag indicating that the API Key has expired.

daysToExpirationOnLastNotificationinteger

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

expireAtstring date-time

The datetime when the API Key expires. No date means no expiration.

createdAtstring date-time

The datetime when the API Key has been created.

updatedAtstring date-time

The datetime when the API Key has been updated.

revokedAtstring date-time

The datetime when the API Key has been revoke. No date means not revoked.

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "key": "my-api-key",
  "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"
  },
  "subscriptions": [
    {
      "id": "34f8c9e7-68fd-4922-b8c9-e778fc790777"
    }
  ],
  "expireAt": "2023-05-18 12:40:46.184000+00:00",
  "createdAt": "2023-01-18 12:40:46.184000+00:00",
  "updatedAt": "2023-01-18 12:40:46.184000+00:00",
  "revokedAt": "2023-01-18 12:40:46.184000+00:00"
}