Remove an environment

Remove the environment with all the data stored in it.

Note: Requires administrator permissions.

delete/_api/environments/{environment}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/environments/:environment/delete.ts
A function with typed inputs. Its response is checked against the schema.

environmentstring string required

The name of the environment.

Successfully removed the environment.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultboolean

Whether environment was successfully removed.

{
  "code": 200,
  "result": true
}

No recorded changes to this operation across all 1 revision of this API.