git.deploy-keys.create

Add a deploy key

POST /git/api/repositories/{repoId}/deploy-keysIAM git:CreateDeployKeyChanges state

Request syntax

POST /git/api/repositories/{repoId}/deploy-keys
{
  "name": "string",
  "publicKey": "string",
  "readOnly": "boolean"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

Request body

  • nameRequired

    string

    A name to recognise the key by, e.g. the machine

    Constraints: 1-64 chars

  • publicKeyRequired

    string

    The OpenSSH public key line, e.g. `ssh-ed25519 AAAA… comment`

    Constraints: 1-4000 chars

  • readOnlyOptional

    boolean

    true lets the key clone and fetch only; false also lets it push. true when absent

Response

201 with the key, as `list` shows it. 400 when `publicKey` is not a valid SSH public key; 409 when the key is already a deploy key.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    The key's id
  • orgIdAlways

    string

    Your organization
  • repoIdAlways

    string

    The repository the record belongs to
  • nameAlways

    string

    The name the key was given
  • publicKeyAlways

    string

    The OpenSSH public key line
  • fingerprintAlways

    string

    The key's SHA256 fingerprint, as `ssh-keygen -l` shows it
  • readOnlyAlways

    boolean

    true: clone and fetch only; false: it may push too
  • lastUsedAtAlways

    string, may be null

    When the key last opened the repository (ISO 8601); null when never
  • createdAtAlways

    string

    When the key was added (ISO 8601)

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:CreateDeployKey on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git deploy-keys create repoId --name example --public-key example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_deploy-keys_create.