Skip to navigation
Modbox APIregistries

Create a registry credential

View as Markdown

Stores credentials for a private Docker registry. The password is encrypted at rest and never returned.

Reference the returned id as registry_id when registering an image with POST /sandbox-images.

Authentication

AuthorizationBearer

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

Headers

x-workspace-idstring or nullOptional

UUID of the workspace that scopes this request. List the workspaces you belong to with GET /workspaces.

Request

This endpoint expects an object.
namestringRequired1-255 characters
serverstringRequired1-512 characters
usernamestringRequired1-255 characters
passwordstringRequired1-512 characters
emailstring or nullOptionalformat: "email"
enabledbooleanOptionalDefaults to true

Response

Successful Response
idstringformat: "uuid"
namestring
serverstring
usernamestring
emailstring or null
enabledboolean
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error