Vexor

sshKey

POST/sshKey.create

sshKey-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

descriptionstring | null

publicKey
Required
string

privateKey
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/sshKey.create" \
  -d '{
  "name": "string",
  "description": "string",
  "publicKey": "string",
  "privateKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/sshKey.remove

sshKey-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

sshKeyId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/sshKey.remove" \
  -d '{
  "sshKeyId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/sshKey.one

sshKey-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

sshKeyId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/sshKey.one?sshKeyId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/sshKey.all

sshKey-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/sshKey.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/sshKey.generate

sshKey-generate

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

typestring

Value in: "rsa" | "ed25519"
Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/sshKey.generate" \
  -d '{
  "type": "rsa"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/sshKey.update

sshKey-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

namestring

Minimum length: 1

descriptionstring | null

lastUsedAtstring | null

sshKeyId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/sshKey.update" \
  -d '{
  "name": "string",
  "description": "string",
  "lastUsedAt": "string",
  "sshKeyId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Previous

settings

Next

gitProvider

On this page

sshKey-createAuthorizationRequest BodysshKey-removeAuthorizationRequest BodysshKey-oneAuthorizationQuery ParameterssshKey-allAuthorizationsshKey-generateAuthorizationRequest BodysshKey-updateAuthorizationRequest Body