Experiment Management API Deployment Endpoints

Name	Description
List deployments	List deployments that experiments or flags can be assigned to.
Create deployment	Create a deployment.
Edit deployment	Edit a deployment.

List deployments

GET https://experiment.amplitude.com/api/1/deployments

GET https://experiment.amplitude.com/api/1/deployments

Fetch a list of deployments that experiments or flags can be assigned to.

Query parameters

Name	Requirement	Type	Description
`limit`	Optional	number	The max number of deployments to be returned. Capped at 1000.
`cursor`	Optional	number	The offset to start the "page" of results from.

Response

A successful request returns a 200 OK response and a list of deployments encoded as JSON in the response body.

Request

curl --request GET \
    --url 'https://experiment.amplitude.com/api/1/deployments?limit=1000' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

curl --request GET \
    --url 'https://experiment.amplitude.com/api/1/deployments?limit=1000' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

Response

{
    "deployments": [
        {
            "id": <id>,
            "projectId": <projectId>,
            "label": "deployment-1",
            "key": <key>,
            "deleted": true
        },
        {
            "id": <id>,
            "projectId": <projectId>,
            "label": "deployment-2",
            "key": <key>,
            "deleted": false
        }
    ]
}

{
    "deployments": [
        {
            "id": <id>,
            "projectId": <projectId>,
            "label": "deployment-1",
            "key": <key>,
            "deleted": true
        },
        {
            "id": <id>,
            "projectId": <projectId>,
            "label": "deployment-2",
            "key": <key>,
            "deleted": false
        }
    ]
}

Create deployment

POST https://experiment.amplitude.com/api/1/deployments

POST https://experiment.amplitude.com/api/1/deployments

Create a deployment that experiments or flags can be assigned to.

Query parameters

Name	Requirement	Type	Description
`projectId`	Required	string	The project's ID.
`label`	Required	string	Deployment's label. Must contain alphanumeric and/or `_`, `-` characters.
`type`	Required	string	Deployment's type. Must be either `client` or `server`.

Request

{
    "projectId":"<projectId>",
    "label": "hello-world",
    "type": "client"
}

{
    "projectId":"<projectId>",
    "label": "hello-world",
    "type": "client"
}

Response

A successful request returns a 200 OK response and a deployment's id.

Request

curl --request POST \
    --url 'https://experiment.amplitude.com/api/1/deployments' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

curl --request POST \
    --url 'https://experiment.amplitude.com/api/1/deployments' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

Example

{
    "id": <id>
}

{
    "id": <id>
}

Edit deployment

PATCH https://experiment.amplitude.com/api/1/deployments/<id>

PATCH https://experiment.amplitude.com/api/1/deployments/<id>

Edit a deployment that experiments or flags can be assigned to.

Query parameters

Name	Requirement	Type	Description
`label`	Optional	string	Deployment's label. Must contain alphanumeric and/or `_`, `-` characters.
`archive`	Optional	boolean	Soft delete or restore deployment.

Request

{
    "label": "updated-label"
}

{
    "label": "updated-label"
}

Response

A successful request returns a 200 OK response and OK text.

Request

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/deployments/<id>' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'

curl --request PATCH \
    --url 'https://experiment.amplitude.com/api/1/deployments/<id>' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer <management-api-key>'