Update a Delivery API key | Documentation

curl -X PUT https://api.contentful.com/spaces/yadj1kx9rmg0/api_keys/api_key_id \
     -H "X-Contentful-Version: 1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "name": "Example API Key",
  "environments": [
    {
      "sys": {
        "type": "Link",
        "linkType": "Environment",
        "id": "staging"
      }
    }
  ]
}'

{
  "sys": {
    "type": "ApiKey",
    "id": "exampleapikey",
    "version": 1,
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "Space",
        "id": "yadj1kx9rmg0"
      }
    },
    "createdAt": "2025-02-08T22:43:15.000Z",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "7BslKh9TdKGOK41VmLDjFZ"
      }
    },
    "updatedAt": "2025-02-08T22:43:15.000Z",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "4FLrUHftHW3v2BLi9fzfjU"
      }
    }
  },
  "name": "Example API Key",
  "description": null,
  "accessToken": "b4c0n73n7fu1",
  "environments": [
    {
      "sys": {
        "type": "Link",
        "linkType": "Environment",
        "id": "staging"
      }
    }
  ],
  "preview_api_key": {
    "sys": {
      "type": "Link",
      "linkType": "PreviewApiKey",
      "id": "1Mx3FqXX5XCJDtNpVW4BZI"
    }
  }
}

Updates a Delivery API key and its corresponding Preview API key. Include the current version in X-Contentful-Version.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in a form of a string

api_key_idstringRequired

ID of the Delivery API key in a form of a string

Headers

X-Contentful-VersionstringRequired

Version of the API key to update

Request

This endpoint expects a map from strings to any.

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful