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

The Instances API from Release — 2 operation(s) for instances.

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

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

This API exposes 2 operations across 2 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.

2 operations 2 paths 1 schemas 2 GET

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 Instances 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 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Instances 2
GET
/instances/{identifier}
Get Instance
instances_show 1 param → 200401404
GET
/apps/{app_id}/spaces/{space_id}/instances
List Instances
instances_index 2 params → 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-instances-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 Environments API
Release Remote Development API