This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List Keypairs

1: 1.3
2: 1.2
3: 1.1
4: 1.0

1 - 1.3

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	marker optional	The last item’s ID from previous request Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeypairListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/keypairs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.3"

Example HTTP response

Response 200

{
    "keypairs": [
        {
            "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
            "name": "keypairname",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "type": "ssh"
        }
    ]
}

2 - 1.2

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	marker optional	The last item’s ID from previous request Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeypairListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/keypairs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.2"

Example HTTP response

Response 200

{
    "keypairs": [
        {
            "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
            "name": "keypairname",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "type": "ssh"
        }
    ]
}

3 - 1.1

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.1	20260531

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	marker optional	The last item’s ID from previous request Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeypairListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/keypairs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.1"

Example HTTP response

Response 200

{
    "keypairs": [
        {
            "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
            "name": "keypairname",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "type": "ssh"
        }
    ]
}

4 - 1.0

get /v1/keypairs

Description

Get keypair list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Type	Name	Description	Schema	Default
query	limit optional	Page size of items Example : `20`	any of [integer, null]	None
query	marker optional	The last item’s ID from previous request Example : `2a9be312-5d4b-4bc8-b2ae-35100fa9241f`	any of [string, null]	None

Responses

HTTP Code	Description	Schema
200	OK	KeypairListResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None

Example HTTP request

Request path

/v1/keypairs

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = virtualserver 1.0"

Example HTTP response

Response 200

{
    "keypairs": [
        {
            "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
            "name": "keypairname",
            "public_key": "ssh-rsa fakeKey Generated-by-SCP",
            "type": "ssh"
        }
    ]
}