How to Guide | Digital Realty

1. Authenticate

Prerequisites

You should have registered in our developer portal. Check this link about how to register an Account.
You should request access to the playground, sandbox and production environment using our Support page. Here is the link to support page to request access to our environments.
You should have an App created in your account to get the client id and client secret. Check this link about how to create an App.

Note : The time data attribute on APIs follows a 24-hour clock starting at 00:00 and ending at 23:59.

Authentication

The bearer token obtained after successful authentication should be passed as credential when calling this API for authentication. Check the Access Token API link for instructions on how to generate your bearer token.

Read the Get Started documentation if you are unaware of your client credentials.

2. Get Information

Get Account Information

Master account Id and account Id need to be passed in the header for this API call. This is needed to indicate your legal entity.
Refer to the Accounts API for instructions on how to retrieve your account information. You may skip this step if you already know your master account Id and account Id.

Get Site Information

Retrieve the available facility information which are assigned to you. You need the site code to indicate to which facility you want to make a request.
Refer to the Sites API for instructions on how to retrieve your site information. You may skip this step if you already know your sites.

3. Get Locations Information

Get Locations Information

The method is used to retrieve location information based on the site.

Method	GET
End point	/v1/locations?site={site}
Headers	Authorization, Master-Account-Id, Account-Id
Query Parameters	site
Body	n/a

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v1/locations?site=<site>' \
--header 'Master-Account-Id: <Master-Account-Id>' \
--header 'Account-Id: <Account-Id>' \
--header 'Authorization: Bearer <access_token>'

Headers

Field Name	Mandatory	Type	Description
Master-Account-Id	true	string	Customer master account identifier.
Account-Id	true	string	Customer account identifier.
Authorization	true	string	Token-based authentication.

Query Parameters

Field Name	Mandatory	Type	Description
site	true	string(6)	Identifier of the DLR facility.

Body

n/a

Sample JSON Response

[
    {
        "id": "031d9bfb132a360061e87e776144b00d",
        "location": "Room 01",
        "parentId": "761d9bfb132a360061e87e776144b006"
    },
    {
        "id": "761d9bfb132a360061e87e776144b006",
        "location": "Rack 01",
        "parentId": "031d9bfb132a360061e87e776144b00d"
    }
]

Payload Description

Field Name	Type	Description
id	string(32)	Identifier of the location.
location	string(40)	Name of the location.
parentId	string(32)	Identifier of the parent location.

Response Codes

Please check the Response Codes overview in case of any issues.

Locations-v1 1.0.0