Environments

Update an environment

Update an environment by its unique identifier environmentId. You can modify the environment name, identifier, color, and other configuration settings.

put/v1/environments/{environmentId}

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/environments/{environmentId}
  • Auth: API key in header Authorization

Path parameters

environmentIdstring required

The unique identifier of the environment

Request body

namestring
identifierstring
parentIdstring
colorstring

Response

OK

Example response

{
  "data": {
    "_id": "60d5ecb8b3b3a30015f3e1a1",
    "name": "Production Environment",
    "_organizationId": "60d5ecb8b3b3a30015f3e1a2",
    "identifier": "prod-env-01",
    "type": "prod",
    "apiKeys": [
      {
        "key": "api-key-1234567890abcdef",
        "_userId": "60d5ecb8b3b3a30015f3e1a4",
        "hash": "hash_value_here"
      }
    ],
    "_parentId": "60d5ecb8b3b3a30015f3e1a3",
    "slug": "production"
  }
}

Changes

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