sshKey

POST`/sshKey.create`

sshKey-create

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`name`
Required
string

Minimum length: 1

`description`string | null

`publicKey`
Required
string

`privateKey`
Required
string

Status code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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

`type`string

Value in: "rsa" | "ed25519"

Status code	Description
`200`	Successful response
`default`	Error 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

`name`string

Minimum length: 1

`description`string | null

`lastUsedAt`string | null

`sshKeyId`
Required
string

Status code	Description
`200`	Successful response
`default`	Error 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"
    }
  ]
}

sshKey

POST/sshKey.create

AuthorizationRequiredBearer <token>

nameRequiredstring

descriptionstring | null

publicKeyRequiredstring

privateKeyRequiredstring

Response

Typescript

POST/sshKey.remove

AuthorizationRequiredBearer <token>

sshKeyIdRequiredstring

Response

Typescript

GET/sshKey.one

AuthorizationRequiredBearer <token>

sshKeyIdRequiredstring

Response

Typescript

GET/sshKey.all

AuthorizationRequiredBearer <token>

Response

Typescript

POST/sshKey.generate

AuthorizationRequiredBearer <token>

typestring

Response

Typescript

POST/sshKey.update

AuthorizationRequiredBearer <token>

namestring

descriptionstring | null

lastUsedAtstring | null

sshKeyIdRequiredstring

Response

Typescript

On this page

POST`/sshKey.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`description`string | null

`publicKey`
Required
string

`privateKey`
Required
string

POST`/sshKey.remove`

`Authorization`
Required
Bearer <token>

`sshKeyId`
Required
string

GET`/sshKey.one`

`Authorization`
Required
Bearer <token>

`sshKeyId`
Required
string

GET`/sshKey.all`

`Authorization`
Required
Bearer <token>

POST`/sshKey.generate`

`Authorization`
Required
Bearer <token>

`type`string

POST`/sshKey.update`

`Authorization`
Required
Bearer <token>

`name`string

`description`string | null

`lastUsedAt`string | null

`sshKeyId`
Required
string