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

The Accounts API from Release — 11 operation(s) for accounts.

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

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

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

16 operations 11 paths 2 schemas 2 DELETE7 GET1 PATCH4 POST2 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 Accounts 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 16

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

Accounts 16
POST
/accounts/{account_id}/settings
Create or update Account
settings_accounts_create_or_update 1 param → 200401404
GET
/accounts/{account_id}/settings
List Accounts
settings_accounts_index 1 param → 200401404
DELETE
/accounts/{account_id}/settings/delete_all
Delete all Account
settings_accounts_delete_all 1 param → 200401404
POST
/accounts/validate
Validate Account
accounts_validate → 200401404
POST
/accounts/{id}/avatar
Avatar Account
accounts_avatar 1 param → 200401404
GET
/accounts/{id}/resources
Resources Account
accounts_resources 1 param → 200401404
PUT
/accounts/{id}/invite_users
Invite users Account
accounts_invite_users 1 param → 200401404
GET
/accounts
List Accounts
accounts_index → 200401404
POST
/accounts
Create Account
accounts_create body → 201401404
GET
/accounts/new
New Account
accounts_new → 200401404
GET
/accounts/{id}/edit
Edit Account
accounts_edit 1 param → 200401404
GET
/accounts/{id}
Get Account
accounts_show 1 param → 200401404
PATCH
/accounts/{id}
Update Account
accounts_update 1 param body → 200401404
PUT
/accounts/{id}
Update Account
accounts_put_update 1 param body → 200401404
DELETE
/accounts/{id}
Delete Account
accounts_destroy 1 param → 200401404
GET
/
List Accounts
admin_accounts_index → 200401404

Schemas 2

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

Account
object
24 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

release-accounts-api-openapi.yml Raw ↑

Other APIs Release publishes across the network.

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