Sandbox

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

GET
POST
GET
PATCH
DELETE

List all sandbox

API for managing sandbox environments that control network access for task runs.

Required API key scopes

task:read

Query parameters

  • limit
    integer
  • offset
    integer

Response


Example request

GET /api/projects/:project_id/sandbox_environments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/sandbox_environments/

Example response

Status 200
RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "network_access_level": "string",
      "allowed_domains": [
        "string"
      ],
      "include_default_domains": true,
      "repositories": [
        "string"
      ],
      "has_environment_variables": true,
      "environment_variable_keys": [
        "string"
      ],
      "private": true,
      "internal": true,
      "effective_domains": [
        "string"
      ],
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
      "custom_image_name": "string",
      "custom_image_status": "string"
    }
  ]
}

Create sandbox

API for managing sandbox environments that control network access for task runs.

Required API key scopes

task:write

Request parameters

  • name
    string
  • network_access_level
    Default: full
  • allowed_domains
    array
  • include_default_domains
    boolean
    Default: false
  • repositories
    array
  • environment_variables
  • private
    boolean
    Default: true
  • custom_image_id
    string | null

Response


Example request

POST /api/projects/:project_id/sandbox_environments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/sandbox_environments/\
	-d name="string"

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "network_access_level": "string",
  "allowed_domains": [
    "string"
  ],
  "include_default_domains": true,
  "repositories": [
    "string"
  ],
  "has_environment_variables": true,
  "environment_variable_keys": [
    "string"
  ],
  "private": true,
  "internal": true,
  "effective_domains": [
    "string"
  ],
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
  "custom_image_name": "string",
  "custom_image_status": "string"
}

Retrieve sandbox

API for managing sandbox environments that control network access for task runs.

Required API key scopes

task:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/sandbox_environments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/sandbox_environments/:id/

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "network_access_level": "string",
  "allowed_domains": [
    "string"
  ],
  "include_default_domains": true,
  "repositories": [
    "string"
  ],
  "has_environment_variables": true,
  "environment_variable_keys": [
    "string"
  ],
  "private": true,
  "internal": true,
  "effective_domains": [
    "string"
  ],
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
  "custom_image_name": "string",
  "custom_image_status": "string"
}

Update sandbox

API for managing sandbox environments that control network access for task runs.

Required API key scopes

task:write

Path parameters

  • id
    string

Request parameters

  • name
    string
  • network_access_level
    Default: full
  • allowed_domains
    array
  • include_default_domains
    boolean
    Default: false
  • repositories
    array
  • environment_variables
  • private
    boolean
    Default: true
  • custom_image_id
    string | null

Response


Example request

PATCH /api/projects/:project_id/sandbox_environments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/sandbox_environments/:id/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "network_access_level": "string",
  "allowed_domains": [
    "string"
  ],
  "include_default_domains": true,
  "repositories": [
    "string"
  ],
  "has_environment_variables": true,
  "environment_variable_keys": [
    "string"
  ],
  "private": true,
  "internal": true,
  "effective_domains": [
    "string"
  ],
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
  "custom_image_name": "string",
  "custom_image_status": "string"
}

Delete sandbox

API for managing sandbox environments that control network access for task runs.

Required API key scopes

task:write

Path parameters

  • id
    string

Example request

DELETE /api/projects/:project_id/sandbox_environments/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/sandbox_environments/:id/

Example response

Status 204 No response body