Get Kvs For Sandbox

GET 
/v1/sandbox/:sandbox_id/kv

Get all Key Value pairs for a sandbox

Requires any of permissions: sandbox:config:view, sandbox:config:edit

Request

Path Parameters

sandbox_id uuidrequired

Sandbox ID

Query Parameters

keys string[]

Keys to filter by

key Key

Possible values: non-empty and <= 128 characters

Filter by case insensitive name

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

sandbox_id uuid

ID of the Sandbox

key Key (string)required

Key (identifier) for this KV pair

value Value (string)

Value for KV pair

notes Notes (string)

Notes to store additonal information for reference

created_timestamp date-time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

last_modified_timestamp date-time

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

• ]

Example (from schema)

[
  {
    "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "key": "string",
    "value": "string",
    "notes": "string",
    "created_timestamp": "2024-07-29T15:51:28.071Z",
    "last_modified_timestamp": "2024-07-29T15:51:28.071Z"
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...