ONoneuptime
Runbook Variable

List Runbook Variable

Endpoint to list all Runbook Variable items

post/runbook-variable/get-list

Request

Request body

limitnumber

Maximum number of items to return. Defaults to 10.

skipnumber

Number of items to skip for pagination. Defaults to 0.

Example request

{
  "query": {
    "createdAt": {
      "_type": "GreaterThan",
      "value": "2026-01-01T00:00:00.000Z"
    },
    "name": {
      "_type": "Search",
      "value": "example"
    }
  },
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true
  },
  "sort": {
    "createdAt": "DESC"
  }
}

Response

Successful response

countnumber

Example response

{
  "data": [
    {
      "_id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "updatedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "deletedAt": {
        "_type": "DateTime",
        "value": "2023-10-01T12:00:00Z"
      },
      "version": 42,
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "runbookId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "PROD_DB_SSH_KEY",
      "description": "Private key of the deploy user on the database hosts",
      "isSecret": true,
      "value": "10.0.4.21",
      "runners": [
        {
          "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
        }
      ],
      "isAvailableToGlobalRunners": true,
      "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
      "deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.