account

List accounts

Returns the main account and its subaccounts. Account listing is available only to the main account.

get/1.3/account/list

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/account/list
  • Auth: HTTP bearer

Query parameters

labelstring

Filter by label key or key-value pair. Repeat the parameter to require all labels. Label keys are matched case-insensitively.

Response

Account list.

Example response

{
  "accounts": {
    "account": [
      {
        "labels": [],
        "roles": {
          "role": [
            "technical"
          ]
        },
        "type": "mymain",
        "username": "test"
      },
      {
        "labels": [],
        "roles": {
          "role": [
            "technical"
          ]
        },
        "type": "sub",
        "username": "my_sub_account"
      },
      {
        "labels": [
          {
            "key": "to_be_removed",
            "value": "after 2022-31-12"
          }
        ],
        "roles": {
          "role": []
        },
        "type": "sub",
        "username": "my_temp_account"
      },
      {
        "labels": [],
        "roles": {
          "role": [
            "billing"
          ]
        },
        "type": "sub",
        "username": "my_billing_account"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.