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

Return to the regular view of this page.

Create Keypair

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

1 - 1.3

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (CURRENT)

Version	Not Before
1.3	-

Parameters

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	KeypairCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	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"

Request body

{
    "name": "keypairname",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
    "name": "keypairname",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "type": "ssh"
}

2 - 1.2

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

State ACTIVE (SUPPORTED)

Version	Not Before
1.2	20260831

Parameters

Type	Name	Description	Schema	Default
body	body required		KeypairCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	KeypairCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	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"

Request body

{
    "name": "keypairname",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
    "name": "keypairname",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "type": "ssh"
}

3 - 1.1

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

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
body	body required		KeypairCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	KeypairCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	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"

Request body

{
    "name": "keypairname",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
    "name": "keypairname",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "type": "ssh"
}

4 - 1.0

post /v1/keypairs

Description

Create a new Keypair or Import a Public Key.

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
body	body required		KeypairCreateRequest

Responses

HTTP Code	Description	Schema
201	Created	KeypairCreateResponse
400	Bad Request	None
401	Unauthorized	None
403	Forbidden	None
409	Conflict	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"

Request body

{
    "name": "keypairname",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "tags": [
        {
            "key": "key",
            "value": "value"
        }
    ]
}

Example HTTP response

Response 201

{
    "fingerprint": "7e:eb:ab:24:ba:d1:e1:88:ae:9a:fb:66:53:df:d3:bd",
    "name": "keypairname",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\nfakeKey\n-----END RSA PRIVATE KEY-----",
    "public_key": "ssh-rsa fakeKey Generated-by-SCP",
    "type": "ssh"
}