Create a new Destination

POST

https://api.contentful.com/spaces/:spaceId/environments/:environmentId/destinations

POST

/spaces/:spaceId/environments/:environmentId/destinations

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/master/destinations \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "name": "Website",
  "description": "Primary website destination",
  "channelId": "71dC9lwYk3p6MkM4GoSc8t",
  "properties": [
    {
      "id": "baseUrl",
      "value": "value"
    }
  ]
}'

201Created

{
  "name": "name",
  "description": "description",
  "properties": [
    {
      "id": "baseUrl",
      "value": "value"
    }
  ],
  "sys": {
    "channel": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "createdAt": "createdAt",
    "createdBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "environment": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "firstPublishedAt": "firstPublishedAt",
    "id": "id",
    "publishedAt": "publishedAt",
    "publishedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "publishedCounter": 1,
    "publishedVersion": 1,
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "type": "Destination",
    "updatedAt": "updatedAt",
    "updatedBy": {
      "sys": {
        "type": "Link",
        "linkType": "linkType",
        "id": "id"
      }
    },
    "version": 1
  }
}

Creates a Destination against an existing Channel and returns it. Every entry in properties must use the ID of a property declared by that Channel and supply a value of its declared type.

Authentication

AuthorizationBearer

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

Path parameters

spaceIdstringRequired

ID of the space.

environmentIdstringRequired

ID of the environment.

Request

This endpoint expects an object.

namestringRequired

Human-readable name of the Destination.

descriptionstringRequired

What this Destination is for.

channelIdstringRequired

ID of the Channel this Destination implements. Fixed once the Destination is created.

propertieslist of objectsRequired

Values for the properties declared by the Channel.

Response

Created - Destination created

namestring

descriptionstring

propertieslist of objects

sysobject