Skip to main content
POST
Rotate a registry robot's secret

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

robot_name
string
required

Response

Successful Response

application
RegistryRobotApplication · object | null
required

The application an application robot belongs to; null for every other kind, and for one whose application is gone.

created_at
string
required
credential_name
string
required

The registry credential holding the login. Unique across the listing, which a robot's name is not.

description
string
required
docker_login
string
required
expires_at
string | null
required

When the registry stops honouring the robot; null for one that never expires.

host
string
required
kind
enum<string>
required

Who the robot belongs to: a member (user), organisation provisioning (organisation: the ci and pull robots) or one application (application).

Available options:
user,
organisation,
application
managed
boolean
required

True for a robot Ankra minted and whose secret it fans out itself. It is listed and read here, never rotated or revoked.

name
string
required

A member's robot: the name it was created under. A managed robot: ci, pull, or app-.

permissions
string[]
required

Every grant the robot holds, written resource:action.

project
string
required
project_name
string
required

What a member addresses the project by: default for the organisation's own, the name it was created under for an extra project, and empty for a project on a registry the organisation runs itself.

projects
string[]
required

Every registry project the robot reaches. A robot is a project-level robot, so this is the one project it was minted on.

robot_name
string
required
rotated_at
string | null
required
scope
enum<string>
required

The preset the grants amount to, or custom when they are neither preset.

Available options:
push,
pull,
custom
secret
string
required
warning
string

Set when the registry answered the secret but the platform could not store or record it: this response is then the only copy.