Resources API - Scrums.com Docs

The Scrums.com API is planned and not yet publicly available. Endpoints and behaviour are subject to change before release.

Resources represent the compute, storage, networking, or service capacity allocated to a project environment. They are the operational units that generate Usage Records and feed into billing.

Base path

/v1/environments/{environment_id}/resources

Endpoints

Method	Path	Description
`GET`	`/v1/environments/{env_id}/resources`	List resources in an environment
`POST`	`/v1/environments/{env_id}/resources`	Allocate a resource
`GET`	`/v1/resources/{id}`	Get a resource
`PATCH`	`/v1/resources/{id}`	Update resource configuration
`DELETE`	`/v1/resources/{id}`	Deallocate a resource

Attributes

Field	Type	Description
`id`	string	Unique identifier
`environment_id`	string	Parent environment reference
`type`	enum	`compute`, `storage`, `database`, `network`, `service`
`name`	string	Descriptive name
`status`	enum	`provisioning`, `active`, `degraded`, `deprovisioned`
`config`	object	Resource-type-specific configuration
`provider`	string	Cloud or service provider identifier
`created_at`	datetime	ISO 8601 timestamp
`updated_at`	datetime	ISO 8601 timestamp

Relationships

Resources belong to Environments and generate Usage Records. Infrastructure-layer resources are also visible via Infrastructure.

Last modified on August 27, 2026