Customer account operations#
This section covers the following customer account operations:
- Get a list of customer Accounts
- Get customer account
- Get a list of customer account status history
- Get a list of customer history
- Get a list of customer account history
- Get a list of all metadata for a resource
- Get specific metadata
- Get details for specific metadata
Get a list of customer accounts#
This operation returns a list that shows customer accounts to which the user has access based on their tenants.
Method | URI |
---|---|
GET | /v1/customer_accounts |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the query parameters for the request:
NAME | Type | Description |
---|---|---|
metadataKey | String | Parameter to filter by whether or not an customer account has a metadata with a key of metadataKey. |
metadataValue | String | Parameter to filter by whether or not an customer account has a metadata with a value of metadataValue. This query parameter should only be used in combination with 'metadataKey' query parameter. If 'metadataValue' query parameter is present in the request without 'metadataKey' query parameter, then the request is considered as a Bad Request. |
domain | String | Parameter to filter by whether or not an customer account is within the specified domain. |
accountType | String | Parameter to filter by whether or not an customer account is of a specified customer account type. |
marker | String | Specifies the first record to be retrieved. The combination of accountType and accountNumber forms the marker, for example, CLOUD:440369. |
limit | Int | The number of results to return past the given marker. The default is 50. |
direction | String | Direction in which you want to page through the results. |
This operation does not require a request body.
Response#
XML response
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccounts xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1">
<link rel="current" href="https://customer.api.rackspacecloud.com/v1/customer_accounts"/>
<link rel="self" href="https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=backward"/>
<link rel="previous" href="https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=forward&marker=CLOUD%3A19293384938"/>
<link rel="last" href="https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=backward&marker=last"/>
<link rel="next" href="https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&marker=CLOUD%3A19293384938&direction=backward"/>
<ns1:customerAccount collectionsStatus="CURRENT"
id="19293384938" lastUpdatedBy="user1" tenantId="19293384938"
domain="19293384938" lastUpdatedDate="2015-04-21T18:00:00.000Z"
name="Hubspot Accounting" number="19293384938"
rcn="RCN-123-456-789" status="Active"
serviceLevel="managed_legacy" type="CLOUD">
<ns2:link
href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/19293384938" rel="via"/>
</ns1:customerAccount>
<ns1:customerAccount id="5342823" lastUpdatedBy="user1"
tenantId="hybrid:5342823"
domain="dedicated:5342823"
lastUpdatedDate="2015-04-21T18:00:00.000Z"
name="FreeLancer Corp" nickname="FreeLancer" number="5342823"
rcn="RCN-123-456-789" status="Active" serviceLevel="intensive"
type="MANAGED_HOSTING">
<ns2:link
href="https://customer.api.rackspacecloud.com/v1/customer_accounts/MANAGED_HOSTING/5342823" rel="via"/>
</ns1:customerAccount>
<ns1:customerAccount id="75842823" lastUpdatedBy="user1"
tenantId="hybrid:75842823" domain="dedicated:75842823"
lastUpdatedDate="2015-04-21T18:00:00.000Z" name="Spot Study"
nickname="Spot" number="75842823" rcn="RCN-123-456-789"
status="Active" serviceLevel="intensive" type="MANAGED_HOSTING">
<ns2:link
href="https://customer.api.rackspacecloud.com/v1/customer_accounts/MANAGED_HOSTING/75842823" rel="via"/>
</ns1:customerAccount>
<ns1:customerAccount id="RAN2823" lastUpdatedBy="user1"
tenantId="RAN2823" domain="RAN2823"
lastUpdatedDate="2015-04-21T18:00:00.000Z" name="Corp Accounts"
nickname="Corp" rcn="RCN-123-456-789"
status="Active" serviceLevel="managed_legacy" type="CLOUD">
<ns2:link
href="https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/RAN2823" rel="via"/>
</ns1:customerAccount>
</ns1:customerAccounts>
JSON response
{
"customerAccount": [
{
"status": "Active",
"parentAccountNumber": 19293384931,
"link": [
{
"rel": "via",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/19293384938"
}
],
"number": 19293384938,
"tenantId": "19293384938",
"domain": "19293384938",
"type": "CLOUD",
"id": "19293384938",
"collectionsStatus": "CURRENT",
"rcn": "RCN-123-456-789",
"name": "Counting Accounting",
"serviceLevel": "managed_legacy",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
},
{
"status": "Active",
"nickname": "SuperDuperPaper",
"link": [
{
"rel": "via",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts/MANAGED_HOSTING/5342823"
}
],
"number": 5342823,
"tenantId": "hybrid:5342823",
"domain": "dedicated:5342823",
"type": "MANAGED_HOSTING",
"id": "5342823",
"rcn": "RCN-123-456-789",
"name": "Super Duper Paper",
"serviceLevel": "intensive",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
},
{
"status": "Active",
"nickname": "Spot",
"link": [
{
"rel": "via",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts/MANAGED_HOSTING/75842823"
}
],
"number": 75842823,
"tenantId": "hybrid:75842823",
"domain": "dedicated:75842823",
"type": "MANAGED_HOSTING",
"id": "75842823",
"rcn": "RCN-123-456-789",
"name": "Spot Study",
"serviceLevel": "intensive",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
},
{
"status": "Active",
"nickname": "Corp",
"link": [
{
"rel": "via",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts/CLOUD/RAN2823"
}
],
"type": "CLOUD",
"id": "RAN2823",
"tenantId": "RAN2823",
"domain": "RAN2823",
"rcn": "RCN-123-456-789",
"name": "Corp Accounts",
"serviceLevel": "managed_legacy",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
}
],
"link": [
{
"rel": "CURRENT",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts"
},
{
"rel": "SELF",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=backward"
},
{
"rel": "PREVIOUS",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=forward&marker=CLOUD%3A19293384938"
},
{
"rel": "LAST",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&direction=backward&marker=last"
},
{
"rel": "NEXT",
"href":
"https://customer.api.rackspacecloud.com/v1/customer_accounts?limit=50&marker=CLOUD%3A19293384938&direction=backward"
}
]
}
Get customer account#
This operation returns details of a customer account identified by an account ID.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId} |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This operation does not require a request body.
Response#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
XML response
Get customer account response - CLOUD
account:
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccount id="10101"
lastUpdatedBy="user1" lastUpdatedDate="2015-04-21T18:00:00.000Z"
name="MyRackspaceAcct" nickname="MyRackspace" number="10101"
domain="10101"
rcn="RCN-123-456-789" status="Active" tenantId="10101"
serviceLevel="managed_legacy" type="CLOUD"
xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1"/>
Get customer account response - ManagedHosting
account:
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccount id="5342823"
lastUpdatedBy="user1" lastUpdatedDate="2015-04-21T18:00:00.000Z"
name="FreeLancer Corp" nickname="FreeLancer" number="5342823"
rcn="RCN-123-456-789" status="Active" tenantId="hybrid:5342823"
serviceLevel="intensive" type="MANAGED_HOSTING"
domain="dedicated:5342823"
xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1"/>
Get customer account response - FAWS
account:
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccount id="5342823"
lastUpdatedBy="user1" lastUpdatedDate="2015-04-21T18:00:00.000Z"
name="FreeLancer Corp" nickname="FreeLancer" number="5342823"
rcn="RCN-123-456-789" status="Active" tenantId="faws:5342823"
type="FANATICAL_SUPPORT_FOR_AWS" domain="12345"
serviceLevel="navigator"
xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1"/>
JSON response
Get customer account response - CLOUD
account:
{
"tenantId": "10101",
"domain": "10101",
"status": "Active",
"nickname": "MyRackspace",
"number": 10101,
"type": "CLOUD",
"id": "10101",
"rcn": "RCN-123-456-789",
"name": "MyRackspaceAcct",
"serviceLevel": "managed_legacy",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
}
Get customer account response - ManagedHosting
account:
{
"tenantId": "hybrid:5342823",
"domain": "dedicated:5342823",
"status": "Active",
"nickname": "FreeLancer",
"number": 5342823,
"type": "MANAGED_HOSTING",
"id": "5342823",
"rcn": "RCN-123-456-789",
"name": "FreeLancer Corp",
"serviceLevel": "intensive",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
}
Get customer account response - FAWS
account:
{
"tenantId": "faws:5342823",
"domain": "10101",
"status": "Active",
"nickname": "FreeLancer",
"number": 5342823,
"type": "FANATICAL_SUPPORT_FOR_AWS",
"id": "5342823",
"rcn": "RCN-123-456-789",
"name": "FreeLancer Corp",
"serviceLevel": "navigator",
"domain": "12345",
"lastUpdatedBy": "user1",
"lastUpdatedDate": "2015-04-21T18:00:00.000Z"
}
Get a list of customer account status history#
This operation returns a list that shows status changes for a given customer account.
Method | URI |
---|---|
GET | /v1/customer_account/{accountType}/{accountId}/status_history |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
This operation does not require a request body.
Response#
XML response:
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccountStatusChanges
xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api" xmlns:ns4="http://customer-admin.api.rackspace.com/v1">
<ns1:statusChange accessPolicy="FULL"
collectionsStatus="DELINQUENT_LEVEL_1"
date="2012-12-31T18:00:00.000Z" fraudStatus="ACCEPT"
status="Active" username="testUserName" usertype="RACKER"/>
<ns1:statusChange accessPolicy="SUSPENDED"
collectionsStatus="DELINQUENT_LEVEL_2"
date="2012-10-02T00:23:00.000Z" fraudStatus="PENDING_APPROVAL"
status="Delinquent" username="testUserName1" usertype="CUSTOMER"/>
<ns1:statusChange date="2012-07-15T18:00:00.000Z"
status="Pending Approval" username="testUserName2" usertype="SYSTEM"/>
</ns1:customerAccountStatusChanges>
JSON response:
{
"statusChange": [
{
"collectionsStatus": "DELINQUENT_LEVEL_1",
"username": "testUserName",
"status": "Active",
"accessPolicy": "FULL",
"usertype": "RACKER",
"date": "2012-12-31T18:00:00.000Z",
"fraudStatus": "ACCEPT"
},
{
"collectionsStatus": "DELINQUENT_LEVEL_2",
"username": "testUserName1",
"status": "Delinquent",
"accessPolicy": "SUSPENDED",
"usertype": "CUSTOMER",
"date": "2012-10-02T00:23:00.000Z",
"fraudStatus": "PENDING_APPROVAL"
},
{
"username": "testUserName2",
"status": "Pending Approval",
"usertype": "SYSTEM",
"date": "2012-07-15T18:00:00.000Z"
}
]
}
Get a list of customer history#
This operation returns a list that shows the customer change history.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId}/customer_history |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
This operation does not require a request body.
Response#
XML response
<?xml version="1.0" encoding="UTF-8"?>
<ns1:accountRCNChanges xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1">
<ns1:accountRCNChange AccountChangeType="NEW"
date="2012-12-31T18:00:00.000Z" rcn="RCN-123-456-789"
username="user0123"/>
<ns1:accountRCNChange AccountChangeType="RCN_UPDATE"
date="2012-12-31T18:00:00.000Z" rcn="RCN-000-000-001"
username="john0987"/>
<ns1:accountRCNChange AccountChangeType="MERGE"
date="2012-12-15T18:00:00.000Z" rcn="RCN-000-000-002"
username="john0987"/>
</ns1:accountRCNChanges>
JSON response
{
"accountRCNChange": [
{
"accountChangeType": "NEW",
"username": "user0123",
"rcn": "RCN-123-456-789",
"date": "2012-12-31T18:00:00.000Z"
},
{
"accountChangeType": "RCN_UPDATE",
"username": "john0987",
"rcn": "RCN-000-000-001",
"date": "2012-12-31T18:00:00.000Z"
},
{
"accountChangeType": "MERGE",
"username": "john0987",
"rcn": "RCN-000-000-002",
"date": "2012-12-15T18:00:00.000Z"
}
]
}
Get a list of customer account history#
This operation returns a list of all customer account history changes.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId}/history{?changeType} |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
This table shows the query parameters for the request:
NAME | Type | Description |
---|---|---|
changeType | AccountChangeType | Optional change type to filter results. |
This operation does not require a request body.
Response#
XML response
<?xml version="1.0" encoding="UTF-8"?>
<ns1:customerAccountHistoryChanges
xmlns:ns1="http://customer.api.rackspace.com/v1"
xmlns:ns2="http://www.w3.org/2005/Atom"
xmlns:ns3="http://docs.rackspace.com/metadata/api"
xmlns:ns4="http://customer-admin.api.rackspace.com/v1">
<ns1:customerAccountHistory accountChangeType="NEW"
accountStatus="Active" rcn="RCN-000-000-001"
updatedDate="2012-12-31T18:00:00.000Z">
<ns1:updatedBy type="SYSTEM" username="abc123"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="COLLECTIONS_STATUS" accountStatus="Active"
collectionsStatus="CURRENT" rcn="RCN-000-000-001"
updatedDate="2012-12-31T18:01:00.000Z">
<ns1:updatedBy type="RACKER" username="abc456"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="RCN_UPDATE" accountStatus="Active"
collectionsStatus="CURRENT" rcn="RCN-000-000-002"
updatedDate="2013-01-31T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc456"/>
<ns1:destinationUpdatedBy type="RACKER" username="xyz123"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="RCN_UPDATE" accountStatus="Active"
collectionsStatus="CURRENT" rcn="RCN-000-000-003"
updatedDate="2013-06-30T18:00:00.000Z">
<ns1:updatedBy type="CUSTOMER" username="john09877"/>
<ns1:destinationUpdatedBy type="RACKER" username="xyz123"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="COLLECTIONS_STATUS" accountStatus="Active"
collectionsStatus="DELINQUENT_LEVEL_1" rcn="RCN-000-000-003"
updatedDate="2013-07-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2222"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="COLLECTIONS_STATUS" accountStatus="Active"
collectionsStatus="DELINQUENT_LEVEL_2" rcn="RCN-000-000-003"
updatedDate="2013-07-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2223"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="COLLECTIONS_STATUS" accountStatus="Active"
collectionsStatus="CURRENT" rcn="RCN-000-000-003"
updatedDate="2013-08-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2223"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="LEGACY_ACCOUNT_STATUS" accountStatus="Closed"
collectionsStatus="CURRENT" rcn="RCN-000-000-003"
updatedDate="2013-09-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2224"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="COLLECTIONS_STATUS" accountStatus="Closed"
collectionsStatus="WRITTEN_OFF" rcn="RCN-000-000-003"
updatedDate="2013-09-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2224"/>
</ns1:customerAccountHistory>
<ns1:customerAccountHistory
accountChangeType="NICKNAME" accountStatus="Closed"
collectionsStatus="WRITTEN_OFF" nickname="rackspace"
rcn="RCN-000-000-003" updatedDate="2013-09-30T18:00:00.000Z">
<ns1:updatedBy type="RACKER" username="abc2224"/>
</ns1:customerAccountHistory>
</ns1:customerAccountHistoryChanges>
JSON response
{
"customerAccountHistory": [
{
"accountChangeType": "NEW",
"rcn": "RCN-000-000-001",
"updatedDate": "2012-12-31T18:00:00.000Z",
"accountStatus": "Active",
"updatedBy": {
"username": "abc123",
"type": "SYSTEM"
}
},
{
"accountChangeType": "COLLECTIONS_STATUS",
"collectionsStatus": "CURRENT",
"rcn": "RCN-000-000-001",
"updatedDate": "2012-12-31T18:01:00.000Z",
"accountStatus": "Active",
"updatedBy": {
"username": "abc456",
"type": "RACKER"
}
},
{
"accountChangeType": "RCN_UPDATE",
"collectionsStatus": "CURRENT",
"rcn": "RCN-000-000-002",
"updatedDate": "2013-01-31T18:00:00.000Z",
"accountStatus": "Active",
"destinationUpdatedBy": {
"username": "xyz123",
"type": "RACKER"
},
"updatedBy": {
"username": "abc456",
"type": "RACKER"
}
},
{
"accountChangeType": "RCN_UPDATE",
"collectionsStatus": "CURRENT",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-06-30T18:00:00.000Z",
"accountStatus": "Active",
"destinationUpdatedBy": {
"username": "xyz123",
"type": "RACKER"
},
"updatedBy": {
"username": "john09877",
"type": "CUSTOMER"
}
},
{
"accountChangeType": "COLLECTIONS_STATUS",
"collectionsStatus": "DELINQUENT_LEVEL_1",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-07-30T18:00:00.000Z",
"accountStatus": "Active",
"updatedBy": {
"username": "abc2222",
"type": "RACKER"
}
},
{
"accountChangeType": "COLLECTIONS_STATUS",
"collectionsStatus": "DELINQUENT_LEVEL_2",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-07-30T18:00:00.000Z",
"accountStatus": "Active",
"updatedBy": {
"username": "abc2223",
"type": "RACKER"
}
},
{
"accountChangeType": "COLLECTIONS_STATUS",
"collectionsStatus": "CURRENT",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-08-30T18:00:00.000Z",
"accountStatus": "Active",
"updatedBy": {
"username": "abc2223",
"type": "RACKER"
}
},
{
"accountChangeType": "LEGACY_ACCOUNT_STATUS",
"collectionsStatus": "CURRENT",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-09-30T18:00:00.000Z",
"accountStatus": "Closed",
"updatedBy": {
"username": "abc2224",
"type": "RACKER"
}
},
{
"accountChangeType": "COLLECTIONS_STATUS",
"collectionsStatus": "WRITTEN_OFF",
"rcn": "RCN-000-000-003",
"updatedDate": "2013-09-30T18:00:00.000Z",
"accountStatus": "Closed",
"updatedBy": {
"username": "abc2224",
"type": "RACKER"
}
},
{
"accountChangeType": "NICKNAME",
"collectionsStatus": "WRITTEN_OFF",
"rcn": "RCN-000-000-003",
"nickname": "rackspace",
"updatedDate": "2013-09-30T18:00:00.000Z",
"accountStatus": "Closed",
"updatedBy": {
"username": "abc2224",
"type": "RACKER"
}
}
]
}
Get a list of all metadata for a resource#
This operation returns a list of all the metadata that is associated to this resource.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId}/metadata |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
This operation does not require a request body.
Response#
XML response
<metadata xmlns="http://docs.rackspace.com/metadata/api">
<meta key="billing:somekey">a value billing cares about</meta>
<meta key="support:level">navigator</meta>
</metadata>
JSON response
{
"metadata": {
"billing:somekey": "a value billing cares about",
"support:level": "navigator"
}
}
Get specific metadata#
This operation returns the metadata that matches the key specified in the resource.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId}/metadata/{metadataKey} |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
{metadataKey} | String | The unique key for a metadata entry. |
This operation does not require a request body.
Response#
XML response
<meta xmlns="http://docs.rackspace.com/metadata/api" key="some:key">Some Value</meta>
JSON response
{
"meta": {
"some:key": "Some Value"
}
}
Get details for specific metadata#
This operation returns details for the metadata resource.
Method | URI |
---|---|
GET | /v1/customer_accounts/{accountType}/{accountId}/metadata/{metadataKey}/detail |
These tables show the possible response codes for this operation:
Normal response codes: |
---|
200 (OK) |
Error response codes: |
---|
500 (Internal Server Error) |
400 (Bad Request) |
401 (Unauthorized) |
403 (Forbidden) |
503 (Service Unavailable) |
404 (Not Found) |
Request#
This table shows the URI parameters for the request:
NAME | Type | Description |
---|---|---|
{accountType} | String | The type of Rackspace customer account. |
{accountId} | String | Unique identifier of a Rackspace customer account. |
{metadataKey} | String | The unique key for a metadata entry. |
This operation does not require a request body.
Response#
XML response
<?xml version="1.0" encoding="UTF-8"?>
<metadataDetail createdBy="service_account_user"
createdDate="2017-04-26T20:46:58.467Z"
key="creation:faws:servicelevelid"
lastUpdatedBy="service_account_admin"
lastUpdatedDate="2017-07-26T20:46:58.467Z" value="some_value"
xmlns="http://docs.rackspace.com/metadata/api"/>
JSON response:
{
"createdBy": "service_account_user",
"lastUpdatedBy": "service_account_admin",
"value": "some_value",
"lastUpdatedDate": "2017-07-26T20:46:58.467Z",
"createdDate": "2017-04-26T20:46:58.467Z",
"key": "creation:faws:servicelevelid"
}