servers.configureCredential

POST

/servers/{serverId}/credentials

const url = 'https://example.com/api/servers/example/credentials';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"credential":{"kind":"local-ssh-agent","username":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/servers/example/credentials \
  --header 'Content-Type: application/json' \
  --data '{ "credential": { "kind": "local-ssh-agent", "username": "example" } }'

Configures the SSH credential Appaloft uses for server connectivity and deployment. Public docs: /docs/servers/credentials/ssh-keys/#server-ssh-credential-path

Parameters

Path Parameters

serverId

required

string

>= 1 characters

Request Body^required

application/json

object

credential

required

One of:

object

kind

required

string

Allowed value: local-ssh-agent

username

string

>= 1 characters

Responses

200

application/json

null

Example ^generated

example

servers.configureCredential

Parameters

Path Parameters

Request Body required

Responses

200

Example generated

Request Body^required

Example ^generated