Archive a release | Documentation

curl -X PUT https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/releases/black-friday-1pQyHCh6c6Ic2qFzXzAWmW/archived \
     -H "X-Contentful-Version: 1" \
     -H "Authorization: Bearer <token>"

{
  "sys": {
    "type": "Release",
    "schemaVersion": "Release.v2",
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "Space",
        "id": "yadj1kx9rmg0"
      }
    },
    "environment": {
      "sys": {
        "type": "Link",
        "linkType": "Environment",
        "id": "staging"
      }
    },
    "status": "",
    "version": 0,
    "archivedAt": "2020-01-01T13:00:00.000Z",
    "archivedBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "7BslKh9TdKGOK41VmLDjFZ"
      }
    },
    "createdAt": "2025-03-19T15:47:08.000Z",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "7BslKh9TdKGOK41VmLDjFZ"
      }
    },
    "updatedAt": "2025-03-19T15:47:08.000Z",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "User",
        "id": "7BslKh9TdKGOK41VmLDjFZ"
      }
    }
  },
  "title": "",
  "entities": [
    {
      "sys": {
        "type": "Array"
      },
      "items": [
        {
          "sys": {
            "id": "",
            "type": "Link",
            "linkType": ""
          }
        },
        "action:"
      ]
    }
  ]
}

Archives a release, preventing publish, unpublish, or scheduling actions. Include 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 form of a string

environment_idstringRequired

ID of the environment in form of a string

release_idstringRequired

ID of the release in form of a string

Headers

X-Contentful-VersionstringRequired

Version of the release to archive

Response headers

Content-Typestring

Content-Type

Response

OK - Request successful