NodeRings Docs

List Provider Customer Assets

GET
/v1/provider/customers/{clientOrganizationId}/assets

Authorization

Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Path Parameters

clientOrganizationIdstring

Query Parameters

page?integer
Formatint32
pageSize?integer

Same rules as ListProviderCustomers.page_size.

Formatint32
search?string
assetType?string
Value in"PROVIDER_CUSTOMER_ASSET_TYPE_UNSPECIFIED" | "PROVIDER_CUSTOMER_ASSET_TYPE_ALL" | "PROVIDER_CUSTOMER_ASSET_TYPE_VIRTUAL_MACHINE" | "PROVIDER_CUSTOMER_ASSET_TYPE_DEDICATED_SERVER" | "PROVIDER_CUSTOMER_ASSET_TYPE_GAME_SERVER"
activityStatus?string

When set (not UNSPECIFIED), only assets matching this activity status are returned.

Value in"PROVIDER_CUSTOMER_VM_ACTIVITY_STATUS_UNSPECIFIED" | "PROVIDER_CUSTOMER_VM_ACTIVITY_STATUS_ACTIVE" | "PROVIDER_CUSTOMER_VM_ACTIVITY_STATUS_INACTIVE"
regionId?string

When set to a non-empty UUID, only assets whose VM node is in this region are returned.

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/provider/customers/{clientOrganizationId}/assets?page&pageSize&search&assetType&activityStatus&regionId" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "assets": [
    {
      "id": "string",
      "assetType": "PROVIDER_CUSTOMER_ASSET_TYPE_UNSPECIFIED",
      "displayName": "string",
      "activityStatus": "PROVIDER_CUSTOMER_VM_ACTIVITY_STATUS_UNSPECIFIED",
      "createdAt": "2019-08-24T14:15:22Z",
      "deleteTime": "2019-08-24T14:15:22Z",
      "spec": "string",
      "region": "string",
      "ipv4": "string",
      "ipv6": "string",
      "os": "string",
      "planName": "string",
      "planCode": "string",
      "regionId": "string"
    }
  ],
  "totalCount": 0
}

Get Provider Customer Stats GET

Path must not be `/customers/stats`: some gateways match `/customers/{client_organization_id}` first and treat "stats" as a UUID field (validation error).

List Provider Customers GET

Next Page