Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceComputeRegistry Credentials

Create a registry credential

Saves a registry login for the org: basic takes username and password; aws_ecr takes accessKeyId, secretAccessKey and region; gcp_gcr takes serviceAccountKey. A missing credential field, or an unknown authType, returns 400. The credentials are stored encrypted, and the response is the credential's summary without them.

Required permission

Requires the registry.write permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl registry-credentials create --auth-type <auth-type> --credentials <credentials> --name <name> --server <server>
POST
/v1/orgs/{orgId}/registry-credentials/create

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Path Parameters

orgId*string

Request Body

application/json
  1. body
name*string
server*string
authType*string
Value in"basic""aws_ecr""gcp_gcr"
credentials*

Response Body

Created

application/json
  1. response
id*string
name*string
server*string
authType*string
createdAt*string
Example Request
curl -X POST 'https://api.openrelay.inc/v1/orgs/string/registry-credentials/create' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "server": "string",  "authType": "basic",  "credentials": {    "property1": "string",    "property2": "string"  }}'
Example Response
{  "id": "string",  "name": "string",  "server": "string",  "authType": "string",  "createdAt": "string"}