v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Environments

Copy Environment Async

Copy environment

This endpoint either duplicates an existing environment to a new environment in the same project, or copies from an existing environment to another existing environment.

The scope object controls which objects will be copied to the target environment.

To clone to a new environment, the user must have write permissions to the containing project. To clone into an existing environment, the user must have write permissions to the target environment.

Copying environments across projects or organizations is not allowed.

post/v2/projects/{proj_id}/envs/{env_id}/copy/async

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Query parameters

waitnumber

Time in seconds to wait for the task to complete. Default is 0, means no wait.

Time in seconds to wait for the task to complete. Default is 0, means no wait.

Request body

conflict_strategy'fail' | 'overwrite'

An enumeration.

Response

Successful Response

task_idstring required

The unique id of the task.

status'processing' | 'success' | 'failure' | 'cancelled' required

An enumeration.