Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

Scope

Update a scope

Changed on Oct 15, 2026

Updates information for a scope.

patch/scope/{id}

Request

Base URL
https://api.nullplatform.com
URL
https://api.nullplatform.com/scope/{id}
Auth
HTTP bearer

Path parameters

idinteger required

The ID of the scope.

Request body

The status of the scope.

tier'testing' | 'non_critical' | 'important' | 'critical'

Defines the tier type of the scope.

capabilitiesobject

Defines optional features such as logging, auto scaling, and spot instances. See the capabilities documentation for details.

asset_namestring

The name of the asset.

messagesobject

Additional system messages related to the scope's status or configuration.

instance_idstring

A unique identifier for the runtime instance associated with this scope.

domainstring

An application-wide unique domain for the scope.

namestring

The name of the scope.

ℹ️ Note: Changing the scope's name does not change the slug, as doing so could break connections with existing applications and services.

dimensionsobject

Defines runtime configuration dimensions, such as environment or region, that apply to this scope.

Example request

{
  "status": "active",
  "requested_spec": {
    "memory_in_gb": 2,
    "cpu_profile": "standard",
    "local_storage_in_gb": 8
  },
  "tier": "important",
  "asset_name": "main-asset",
  "instance_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "domain": "billing-api-prod.nullapps.io",
  "name": "Payments API.",
  "dimensions": {
    "environment": "production"
  }
}

Response

The status change (such as stopping, recreating, or deleting) was accepted and is being processed. The response has no body.

Changes

Oct 15, 2026728d4df70ca1 Revision changes
- breaking
  the request property / became required
- breaking
  the request property / became required
- breaking
  the request property / became required
- breaking
  removed the media type application/json for the response with the status
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  the request property's maxLength was set to 60
- warning
  the request property's maxLength was set to 255
- warning
  the request property's maxLength was set to 100
- warning
  the / request property's max was set to 128.00
- warning
  the / request property's max was set to 128.00
- warning
  the / request property's min was set to 0.05
- warning
  removed the request property
- info
  the request property default value 2 was removed
- info
  the request property default value 2 was removed
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  response property message deprecated
- info
  response property message deprecated
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the success response with the status
Sep 22, 2026730fb95f21b8 Revision changes
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response optional property became read-only for the status
- info
  the response required property became read-only for the status
- info
  the response required property became read-only for the status

Operation history