v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Dynamic Configs

Archive Dynamic Config

put/console/v1/dynamic_configs/{id}/archive

Path parameters

idstring required

Request body

forceArchiveboolean

archiveReasonstring

The reason for archiving the gate

Example request

{
  "archiveReason": "The gate is no longer needed"
}

Response

Archive Dynamic Config Response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "data": {
    "name": "my_config",
    "idType": "userID",
    "description": "helpful summary of what this dynamic config does",
    "tags": [
      "a tag"
    ],
    "owner": {
      "ownerID": "user123",
      "ownerType": "USER",
      "ownerName": "John Doe",
      "ownerEmail": "owner123@test.com"
    }
  }
}