> For the complete documentation index, see [llms.txt](https://developer.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.collibra.com/api/references/console/environment.md).

# Environment

## GET /environment

> List all environments

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment":{"get":{"operationId":"findAll_2","responses":{"default":{"content":{"application/json":{}},"description":"default response"}},"summary":"List all environments","tags":["environment"]}}}}
```

## POST /environment

> Create a new environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment":{"post":{"operationId":"add","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"The model of the environment to create"},"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Create a new environment","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## GET /environment/{environmentId}

> Get an environment by ID

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}":{"get":{"operationId":"getById_4","parameters":[{"description":"The ID of the environment to retrieve","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Get an environment by ID","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## PUT /environment/{environmentId}

> Change an existing environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}":{"put":{"operationId":"change","parameters":[{"description":"The ID of the environment to change","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"The new model for the environment to change"},"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Change an existing environment","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## DELETE /environment/{environmentId}

> Delete an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}":{"delete":{"operationId":"remove_2","parameters":[{"description":"The ID of the environment to delete","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"successful operation"}},"summary":"Delete an environment","tags":["environment"]}}}}
```

## POST /environment/{environmentId}/add/{managedServiceId}

> Add a managed service to an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}/add/{managedServiceId}":{"post":{"operationId":"addService","parameters":[{"description":"The ID of the target environment","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}},{"description":"The ID of the managed service to add to the environment","in":"path","name":"managedServiceId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Add a managed service to an environment","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## POST /environment/{environmentId}/addServiceProvider/{serviceProviderId}

> Add a service provider to an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}/addServiceProvider/{serviceProviderId}":{"post":{"operationId":"addServiceProvider","parameters":[{"description":"The ID of the target environment","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}},{"description":"The ID of the service provider to add to the environment","in":"path","name":"serviceProviderId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Add a service provider to an environment","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## POST /environment/{environmentId}/remove/{serviceProviderId}

> Remove a service provider from an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}/remove/{serviceProviderId}":{"post":{"operationId":"removeService","parameters":[{"description":"The ID of the target environment","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}},{"description":"The ID of the service provider to remove from the environment","in":"path","name":"serviceProviderId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentModel"}}},"description":"default response"}},"summary":"Remove a service provider from an environment","tags":["environment"]}}},"components":{"schemas":{"EnvironmentModel":{"type":"object","properties":{"createdDate":{"type":"string","format":"date-time"},"id":{"type":"string","format":"uuid"},"modifiedDate":{"type":"string","format":"date-time"},"name":{"type":"string"},"serviceIdSet":{"type":"array","items":{"type":"string","format":"uuid"},"uniqueItems":true},"status":{"type":"string","enum":["INCOMPLETE","RUNNING","PARTIALLY_RUNNING","STOPPED","ERROR","STARTING","STOPPING","UPGRADING","RESTORING_BACKUP"]}}}}}}
```

## POST /environment/{environmentId}/start

> Start an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}/start":{"post":{"operationId":"start","parameters":[{"description":"The ID of the environment to start","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"successful operation"}},"summary":"Start an environment","tags":["environment"]}}}}
```

## POST /environment/{environmentId}/stop

> Stop an environment

```json
{"openapi":"3.0.3","info":{"title":"Collibra Management Console","version":"v1"},"servers":[{"url":"/rest"}],"paths":{"/environment/{environmentId}/stop":{"post":{"operationId":"stop","parameters":[{"description":"The ID of the environment to stop","in":"path","name":"environmentId","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"successful operation"}},"summary":"Stop an environment","tags":["environment"]}}}}
```