Get the Mission Control-specific details of an environment.
Your token must have one of the permissions listed in the Token Permissions.
environments:view ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/environments/{id}": {
"get": {
"tags": [
"Environments"
],
"summary": "(Beta) Get details of an environment in Mission Control",
"description": "Get the Mission Control-specific details of an environment.
Your token must have one of the permissions listed in the Token Permissions.
environments:view ]",
"operationId": "getEnvironment",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The unique identifier of the environment.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"description": "Populate additional hidden attributes",
"required": false,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EnvironmentResponse"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Access Denied.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Subject does not have permission [environments:view]",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Could not find environment environmentId",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"409": {
"description": "Conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"Environment": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for this environment."
},
"type": {
"type": "string",
"description": "The type of object for informational purposes."
},
"allowServiceCreationInPublicRegions": {
"type": "boolean",
"description": "When this setting is false, it blocks the creation of services in public regions in this environment."
}
}
},
"EnvironmentResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Environment"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']",
"items": {
"type": "string",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```