Site SSH credentials

Returns SSH credentials for a specific site.

GET

https://portal.onyx.io/api/v2/sites/{site}/ssh_credentials

If successful, this endpoint will return a 200 OK status.

Arguments

The following arguments are supported for this endpoint.

Name	Type	Default Value
site Required	Site Lookup	None

The following errors may occur during this request.

Details	HTTP status
site_not_found No site was found matching any of the criteria provided in the arguments	404 Not Found
ssh_not_enabled The site SSH connection is disabled.	409 Conflict

Details

HTTP status

No site was found matching any of the criteria provided in the arguments

404 Not Found

The site SSH connection is disabled.

409 Conflict

When the request is successful, you can expect an object matching the specification below to be returned.

{
    hostname: String
    port: String
    username: String
    password: String
}