Create a design library version

POST

https://api.contentful.com/spaces/:spaceId/design_libraries/:designLibraryId/versions

POST

/spaces/:spaceId/design_libraries/:designLibraryId/versions

curl -X POST https://api.contentful.com/spaces/spaceId/design_libraries/designLibraryId/versions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "description": "string"
}'

{
  "sys": {
    "id": "string",
    "type": "string",
    "completedAt": "string",
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "designLibrary": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "space": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "status": "created"
  },
  "name": "string",
  "description": "string",
  "itemCounts": {
    "experienceTemplates": 1.1,
    "components": 1.1,
    "designTokens": 1.1,
    "contentTypes": 1.1,
    "dataAssemblies": 1.1,
    "editorInterfaces": 1.1
  },
  "errors": [
    {
      "sys": {
        "type": "string",
        "name": "string"
      },
      "message": "string",
      "details": "string"
    }
  ]
}

Creates an immutable snapshot of the design library’s items asynchronously from its source space.

Included items

The version copies items selected by the design library’s taxonomy concept, along with their related data assemblies. Set includeLinkedContentTypes to true to also include related content types and editor interfaces.

See How items are included.

A 201 response queues processing.
Poll Get a design library version until sys.status is succeeded or failed.

A version can contain at most 1,000 unique fetched items across all item types, including derived content types and data assemblies.

See Design library limits.

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

designLibraryIdstringRequired

Request

Body

namestringRequired1-256 characters

descriptionstring or nullRequired<=1000 characters

A description of up to 1,000 characters, or null for no description. This field is required.

optionsobjectOptional

Response

The version was created and queued for processing. This response does not indicate that the snapshot is complete.

sysobject

namestring

descriptionstring or null

itemCountsobject

errorslist of objectsOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error