Partner

Partner API gives UpCloud partners the ability manage accounts for their customers.

Note that use of this API is available only to accounts provisioned as partner accounts. Please contact your account representative for further details.

Get account list

GET

https://api.upcloud.com

/1.3/partner/accounts

Returns list of accounts associated with the partner.

Get account list › Responses

A list of partner accounts.

partnerAccount[]

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string

Create new account

POST

https://api.upcloud.com

/1.3/partner/accounts

Creates new UpCloud account that will be linked to partner's existing invoicing.

Create new account › Request Body

partnerCreateAccount

username

string · required

password

string · required

object

Create new account › Responses

Created partner account.

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string

POST/1.3/partner/accounts

curl https://api.upcloud.com/1.3/partner/accounts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "username": "newuser",
  "password": "superSecret123",
  "contact_details": {
    "address": "Some street",
    "city": "Some city",
    "company": "Some company",
    "country": "FIN",
    "email": "some.user@example.com",
    "first_name": "Some",
    "last_name": "User",
    "phone": "+358.91234567",
    "postal_code": "00100",
    "state": "",
    "vat_number": "FI24315605"
  }
}'

Example Request Body

{
  "username": "newuser",
  "password": "superSecret123",
  "contact_details": {
    "address": "Some street",
    "city": "Some city",
    "company": "Some company",
    "country": "FIN",
    "email": "some.user@example.com",
    "first_name": "Some",
    "last_name": "User",
    "phone": "+358.91234567",
    "postal_code": "00100",
    "state": "",
    "vat_number": "FI24315605"
  }
}

json

Example Responses

{
  "address": "Some street",
  "city": "Some city",
  "company": "Some company",
  "country": "FIN",
  "email": "some.user@example.com",
  "first_name": "Some",
  "last_name": "User",
  "phone": "+358.91234567",
  "postal_code": "00100",
  "state": "",
  "username": "somename",
  "vat_number": "FI24315605"
}

json

application/json

Kubernetes Block Storage

Get account list

GET

https://api.upcloud.com

/1.3/partner/accounts

Returns list of accounts associated with the partner.

Get account list › Responses

A list of partner accounts.

partnerAccount[]

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string

Create new account

POST

https://api.upcloud.com

/1.3/partner/accounts

Creates new UpCloud account that will be linked to partner's existing invoicing.

Create new account › Request Body

partnerCreateAccount

username

string · required

password

string · required

object

Create new account › Responses

Created partner account.

partnerAccount

username

string · required

address

string

city

string

company

string

country

string · iso-3166-1-alpha-3

email

string · email

first_name

string

last_name

string

phone

string

postal_code

string

state

string

vat_number

string