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 Configs API

The Configs API from Release — 9 operation(s) for configs.

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

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

This API exposes 11 operations across 9 paths, and defines 1 schema. 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.

11 operations 9 paths 1 schemas 8 GET3 POST

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 Configs 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 11

Across 9 paths, the API surfaces 11 operations — 8 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Configs 11
POST
/configs/validate
Validate Config
configs_validate → 200401404
GET
/apps/{app_id}/spaces/{space_id}/serialized_configs
List Serialized configs
serialized_configs_index 2 params → 200401404
POST
/apps/{app_id}/spaces/{space_id}/serialized_configs
Create Serialized config
serialized_configs_create 2 params body → 201401404
GET
/apps/{app_id}/spaces/{space_id}/serialized_configs/{id}
Get Serialized config
serialized_configs_show 3 params → 200401404
GET
/apps/{app_id}/spaces/{space_id}/latest_config
Get latest app config
serialized_configs_latest_config 2 params → 200401404
GET
/apps/{app_id}/spaces/{space_id}/latest_env_config
Get latest env config
serialized_configs_latest_env_config 2 params → 200401404
GET
/apps/{app_id}/serialized_configs
List Serialized configs
serialized_configs_get_index 1 param → 200401404
POST
/apps/{app_id}/serialized_configs
Create Serialized config
serialized_configs_post_create 1 param body → 201401404
GET
/apps/{app_id}/serialized_configs/{id}
Get Serialized config
serialized_configs_get_show 2 params → 200401404
GET
/apps/{app_id}/latest_config
Get latest app config
serialized_configs_get_latest_config 1 param → 200401404
GET
/apps/{app_id}/latest_env_config
Get latest env config
serialized_configs_get_latest_env_config 1 param → 200401404

Schemas 1

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

Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

release-configs-api-openapi.yml Raw ↑

Other APIs Release publishes across the network.

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