Archive a segment
Archive a segment with the specified ID. Archived segments are hidden from the main list but can be restored later.
Authorization
AccessToken Use access token to access this API. Example: "Authorization: api-MzQ..."
In: header
Path Parameters
uuiduuidHeader Parameters
The organization ID associated with the request. Some APIs require this header to identify the organization context. When authenticating with an Access Token, this header is automatically populated from the token and does not need to be provided manually.
The workspace ID associated with the request. Some APIs require this header to identify the workspace context. When authenticating with an Access Token, this header is automatically populated from the token and does not need to be provided manually.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Optional payload carrying a user-supplied comment for operations that do not have a dedicated request body. This allows users to provide context for their actions, which can be valuable for auditing and understanding the history of changes.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/envs/497f6eca-6276-4993-bfeb-53cbbbba6f08/segments/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "errors": [ "string" ], "data": true}