Rename a Global Environment

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Renames an existing global environment.

Since: 7.53.1

Security: Requires a user assigned the Administer the Platform role.

Usage: POST ${baseUrl}/v1/environments/{environment_name}/rename

Sample Request:

{
  "new_name": "<string>"
}

Note

The maximum length of an environment name is 32 characters.

Sample Response (successful):

{
  "new_name": "<string>"
}

Sample Response (error):

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "detail": "<string>"
    },
    {
      "code": "<string>",
      "message": "<string>",
      "detail": "<string>"
    }
  ]
}

Status Codes:

Code

Description

200

Renamed Successfully

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict