git.ssh-keys.create

Register an SSH public key

POST /git/api/ssh-keysIAM git:RegisterSshKeyChanges state

Request syntax

POST /git/api/ssh-keys
{
  "name": "string",
  "publicKey": "string"
}

Request body

  • nameRequired

    string

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

    Constraints: 1-64 chars

  • publicKeyRequired

    string

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

    Constraints: 1-4000 chars

Response

201 with the key, as `list` shows it. 400 for a key that does not parse, 409 for one already registered (by anyone).

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

Fields of data

  • idAlways

    string

    The key id
  • orgIdAlways

    string

    The organization
  • iamUserIdAlways

    string

    The IAM user it identifies
  • nameAlways

    string

    Its name
  • publicKeyAlways

    string

    The public key, as registered
  • fingerprintAlways

    string

    Its SHA256 fingerprint
  • lastUsedAtAlways

    string, may be null

    When it was last used (ISO 8601); null if never
  • createdAtAlways

    string

    When it was registered (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:RegisterSshKey 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 ssh-keys create --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_ssh-keys_create.