Sign in
Scope

List scopes

List scopes within an application.

get/scope

Query parameters

offsetinteger

The starting point for pagination. Defaults to 0 if not provided.

limitinteger

The maximum number of results to return per page.

application_idstring required

The ID of the application for the scopes being listed. Allows up to 10 comma-separated values."

include_messagesboolean

Specifies whether it includes messages in the response.

status'pending_approval' | 'pending_hook' | 'pending_approval_denied' | 'pending' | 'creating' | 'active' | 'updating' | 'updating_approval' | 'deleting' | 'deleted' | 'failed' | 'stopping' | 'stopped' | 'cancelled'

Status of the scope.

type'custom' | 'web_pool' | 'web_pool_k8s' | 'serverless'

Type of the scope.

nrnstring

Filters scopes matching or more specific than the provided NRN. When provided, scopes are listed across the org/account/namespace/application hierarchy instead of by application_id.

namestring

Filters scopes by name.

slugstring

Filters scopes by slug.

dimensionsstring

Filters scopes by dimensions.

sortstring

Sort field and direction, separated by a colon. Defaults to created_at:desc.

Response

The list of scopes matching the query.

Example response

{
  "paging": {
    "total": 30,
    "limit": 200
  },
  "results": [
    {
      "id": 1234,
      "name": "Billing API",
      "asset_name": "main-asset",
      "type": "custom",
      "provider": "9e84a5c3-6c2e-4f15-90b0-1c67fd37f6e8",
      "status": "active",
      "slug": "billing-api",
      "domain": "billing-api-prod.nullapps.io",
      "application_id": 2345,
      "requested_spec": {
        "memory_in_gb": 2,
        "cpu_profile": "standard",
        "local_storage_in_gb": 8
      },
      "tier": "important",
      "tags": [
        "requires_deployment",
        "high_priority"
      ],
      "profiles": [
        "environment_production"
      ],
      "dimensions": {
        "environment": "production"
      },
      "runtime_configurations": [
        1234,
        2345
      ],
      "domains": [
        {
          "id": "e78a0d21-3c48-7421-81cd-203fe84b8e47",
          "name": "api.crypto-inc.com",
          "type": "scope",
          "selector": {
            "organization_id": "1",
            "nrn": "organization=1:account=2:namespace=3:application=4",
            "scope_id": "1234"
          },
          "status": "active",
          "created_at": "2025-01-02T00:00:00Z",
          "updated_at": "2025-02-02T00:00:00Z"
        }
      ],
      "instance_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "application_name": "Billing Service",
      "stops_at": "2026-04-01T00:00:00Z",
      "created_at": "2025-01-02T00:00:00Z",
      "updated_at": "2025-06-15T12:30:00Z",
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Changes

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