Get SSH key pair

GET

/repositories/{workspace}/{repo_slug}/pipelines_config/ssh/key_pair

Retrieve the repository SSH key pair excluding the SSH private key. The private key is a write only field and will never be exposed in the logs or the REST API.

Authorizations

• oauth2
  pipeline
• basic
• api_key

Parameters

Path Parameters

workspace

required

string

This can either be the workspace ID (slug) or the workspace UUID surrounded by curly-braces, for example {workspace UUID}.

repo_slug

required

string

The repository.

Responses

200

The SSH key pair.

Media type application/json

object

type

required

string

private_key

The SSH private key. This value will be empty when retrieving the SSH key pair.

string

public_key

The SSH public key.

string

Example ^generated

{
  "type": "example",
  "private_key": "example",
  "public_key": "example"
}

404

The account, repository or SSH key pair was not found.

Media type application/json

Error

Base type for most resource objects. It defines the common type element that identifies an object’s type. It also identifies the element as Swagger’s discriminator.

object

type

required

string

error

object

message

required

string

detail

string

data

Optional structured data that is endpoint-specific.

object

key

additional properties

any

key

additional properties

any

Example ^generated

{
  "type": "example",
  "error": {
    "message": "example",
    "detail": "example",
    "data": {}
  }
}