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

The Apps API from Release — 8 operation(s) for apps.

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

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

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

12 operations 8 paths 2 schemas 1 DELETE7 GET1 PATCH2 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 Apps 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 12

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

Apps 12
POST
/apps/{id}/clone
Clone app
apps_clone 1 param → 200401404
GET
/apps/{id}/branches_and_tags
List branches and tags
apps_branches_and_tags 1 param → 200401404
GET
/apps/check_app_name
Check app name App
apps_check_app_name → 200401404
GET
/apps/{id}/services
List app services
apps_services 1 param → 200401404
GET
/apps
List Apps
apps_index → 200401404
POST
/apps
Create App
apps_create body → 201401404
GET
/apps/new
New App
apps_new → 200401404
GET
/apps/{id}/edit
Edit App
apps_edit 1 param → 200401404
GET
/apps/{id}
Get App
apps_show 1 param → 200401404
PATCH
/apps/{id}
Update App
apps_update 1 param body → 200401404
PUT
/apps/{id}
Update App
apps_put_update 1 param body → 200401404
DELETE
/apps/{id}
Delete App
apps_destroy 1 param → 200401404

Schemas 2

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

App
object
5 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

release-apps-api-openapi.yml Raw ↑

Other APIs Release publishes across the network.

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