Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Release Environments API

The Environments API from Release — 6 operation(s) for environments.

Release Environments API is one of 9 APIs that Release publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Environments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.release.com.

8 operations 6 paths 2 schemas 1 DELETE2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.release.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Release Environments API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-User-Email (userEmail). An API key is passed in the header as X-User-Token (userToken). By default, every request must be authenticated.

  • userEmail — User's email address for authentication
  • userToken — User's authentication token (from ~/.release.yaml)

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Environments 8
PUT
/apps/{app_id}/spaces/{id}/extend_expiration
Extend environment expiration
spaces_extend_expiration 2 params → 200401404
POST
/apps/{app_id}/spaces/{id}/pause
Pause environment
spaces_pause 2 params → 200401404
POST
/apps/{app_id}/spaces/{id}/resume
Resume environment
spaces_resume 2 params → 200401404
POST
/apps/{app_id}/spaces/{id}/override_schedule
Override environment schedule
spaces_override_schedule 2 params → 200401404
GET
/apps/{app_id}/spaces
List Spaces
spaces_index 3 params → 200401404
POST
/apps/{app_id}/spaces
Create Space
spaces_create 1 param body → 201401404
GET
/apps/{app_id}/spaces/{id}
Get Space
spaces_show 2 params → 200401404
DELETE
/apps/{app_id}/spaces/{id}
Delete Space
spaces_destroy 2 params → 200401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Space (32 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Space
object
32 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

release-environments-api-openapi.yml Raw ↑

Other APIs Release publishes across the network.

Release Accounts API
Release Apps API
Release Builds API
Release Clusters API
Release Configs API
Release Deploys API
Release Instances API
Release Remote Development API