Create a design library installation

POST

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/design_libraries/:designLibraryId/installations

POST

/spaces/:spaceId/environments/:environmentId/design_libraries/:designLibraryId/installations

curl -X POST https://api.contentful.com/spaces/spaceId/environments/environmentId/design_libraries/designLibraryId/installations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "version": {
    "sys": {
      "type": "string",
      "linkType": "string",
      "id": "string"
    }
  }
}'

{
  "sys": {
    "completedAt": "string",
    "createdAt": "string",
    "createdBy": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "designLibrary": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "environment": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "id": "string",
    "space": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    },
    "status": "created",
    "type": "string",
    "version": {
      "sys": {
        "id": "string",
        "linkType": "string",
        "type": "string"
      }
    }
  }
}

Installs a succeeded design library version into the target environment asynchronously.

Installation requirements:

The library must be owned by or shared with the target space.
Installation into the library’s source environment is rejected.

A target organisation can have up to 100 concurrent design library installations across all its spaces, environments and libraries. Installations with sys.status set to created or in_progress count towards this limit. Installations with status succeeded or failed do not count.

When the limit is reached, this endpoint returns 409 Conflict with the message Parallel installation limit reached and details.limit set to 100. No installation is created or queued. Retry after an active installation finishes and capacity becomes available.

A 201 response queues processing. Retrieve the installation using Get a design library installation until sys.status is succeeded or failed.

Authentication

AuthorizationBearer

Contentful Management API token

Path parameters

spaceIdstringRequired

environmentIdstringRequired

designLibraryIdstringRequired

Request

Body

versionobjectRequired

A link to the succeeded version of this design library to install.

Response

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

object

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