Skip to main content

Read a scope

Provides information about the scope

Query Parameters
metadata_include string

Comma separated properties that should be included in the metadata response, available values [schemas, tags]

Example: schema,tags

Responses
200

An object representing the scope

Schema OPTIONAL
id integer

A system-wide unique ID for the scope

name string

Possible values: length ≤ 60

The scope name

type string

Possible values: [web_pool, scheduled_tasks, serverless]

status string

Possible values: [pending, creating, active, updating, deleting, deleted, failed]

slug string

Possible values: length ≤ 60

An application-wide unique slug for the scope

domain string

Possible values: length ≤ 60

An application-wide unique slug for the scope

application_id integer

The ID of the application that owns this scope

requested_spec object

The technical specs for this scope (will be replaced by capabilities)

memory_in_gb number OPTIONAL
cpu_profile string OPTIONAL

Possible values: [standard, intensive]

local_storage_in_gb number OPTIONAL
capabilities object

Configures capabilities such as logs, auto scaling, spot instances, and more. See the 'capabilities' section

messages object OPTIONAL
tier string OPTIONAL

Possible values: [testing, non_critical, important, critical]

external_created boolean OPTIONAL

false when the scope is provisioned by nullplatform, true if the scope was provisioned externally to nullplatform (eg: Terraform)

tags string[] OPTIONAL
profiles string[] OPTIONAL

NRN profiles that have to be applied to this scope (independently of the runtime configurations that apply)

dimensions object OPTIONAL

Runtime configuration dimensions that apply to this scope

runtime_configurations integer[] OPTIONAL

Runtime configurations that apply to this scope based on its dimensions and values

metadata object OPTIONAL

The metadata loaded via metadata api

key string OPTIONAL

The key of the metadata

value string OPTIONAL

The value of the metadata

additional_properties object OPTIONAL

Additional properties of the metadata

schemas array OPTIONAL

The json schemas of the metadata

tags object[] OPTIONAL
key string OPTIONAL
value string OPTIONAL