Remove system environment associations

DELETE

/api-catalog/system-environments/:systemEnvironmentId/associations

DELETE

/api-catalog/system-environments/:systemEnvironmentId/associations

$ curl -X DELETE https://api.postman.com/api-catalog/system-environments/23b554c1-c30c-483d-bf98-dbe9ab7b88a0/associations \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "workspaceEnvironmentIds": [
>     "12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619",
>     "56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffb"
>   ]
> }'

1 {
2   "meta": {
3     "deleted": 1,
4     "notFound": 1
5   },
6   "data": [
7     {
8       "workspaceEnvironmentId": "12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619",
9       "status": "deleted"
10     },
11     {
12       "workspaceEnvironmentId": "56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffb",
13       "status": "notFound"
14     }
15   ]
16 }

Removes workspace-environment associations from a system environment.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

systemEnvironmentIdstringRequired

The system environment's ID.

Request

This endpoint expects an object.

workspaceEnvironmentIdslist of stringsRequired

A list of workspace environment IDs to remove. Accepts both the environment ID or the environment’s unique ID (userId-environmentId).

Response

Successful Response

metaobject

The response's meta information for paginated results.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error