CrossConnectInventory-v2 2.0.0

Inventory

1. Authenticate

Prerequisites

  1. You should have registered in our developer portal. Check this link about how to register an Account.
  2. 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.
  3. 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. Permissions

3. 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.

4. Get Cross Connect Information

Retrieve a List of Cross Connects

The method can be used to retrieve the cross connect inventory of the customers account. 

 Method GET
End point /v2/cross-connect-inventory
Headers Authorization, Master-Account-Id, Account-Id
Query Parameters site,billingAccountNumber, interconnectionPanel, interconnectionPortStatus, offset, limit
Body n/a

 

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v2/cross-connect-inventory' \
--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 false string(6) Site Id
billingAccountNumber false string(45) Customer Business Account Number
interconnectionPanel false string(80) Cross Connect Interconnection Panel Identifier
interconnectionPortStatus false string(enum) Status of Cross Connect Interconnection Port.
values: [Pre-Wired, Available, In-Service]
limit false integer Specifies the maximum number of records per page
Default value: 25
offset false integer Determines the starting point for fetching records. Specifies how many pages to skip. For example, if you set an offset of 10, the response will fetch records from the 11th page onward.
Default value: 0

 

Body

n/a

Sample JSON Response

{
    "content": [
        {
            "id": "ZR0D02Q2HCCQY7",
            "site": "LAX010",
            "billingAccountNumber": "130-C14290",
            "accountId": "0012E00002dzucpQAA",
            "interconnectionPanel": "550.09.12.RU21",
            "interconnectionPortId": "98",
            "interconnectionPortStatus": "In-Service",
            "mediaType": "Fiber",
            "zPanelId": "130.11.200.29",
            "zPortNo": "46"
        }
    ],
    "pageable": {
        "last": false,
        "totalPages": 168,
        "totalElements": 4180,
        "size": 25,
        "number": 0,
        "numberOfElements": 25,
        "first": true,
        "empty": false
    }
}

 

Payload Description

Field Name Type Description
id string Identifier of the Cross Connect.
site string(6) Data Center Site Code.
billingAccountNumber string(45) Customer Business Account Number.
accountId string Customer account identifier
interconnectionPanel string(80) Cross Connect Interconnection Panel Identifier.
interconnectionPortId string(4k) Cross Connect Interconnection Port Number.
interconnectionPortStatus string(enum) Status of Cross Connect Interconnection Port.
values: [Pre-Wired, Available, In-Service]
mediaType string(enum) Cross Connect Physical Medium.
values: [Ethernet, Fiber, DS1]
zPanelId string Z-end Customer Panel Identifier.
zPortNo string Z-end Customer Port Number.

5. Get Cross Connect Information by Id

Retrieve Cross Connect Details

The method can be used to retrieve the details of a cross connect. 

 Method GET
End point /v2/cross-connect-inventory/{id}
Headers Authorization, Master-Account-Id, Account-Id
Query Parameters n/a
Body n/a

 

Sample Curl Request

curl --location --request GET 'https://api.digitalrealty.com/v2/cross-connect-inventory/<id>' \
--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

n/a

Body

n/a

Sample JSON Response

{
    "id": "ZR0D02Q2HCCQY7",
    "site": "LAX010",
    "location": "STE0550",
    "billingAccountNumber": "130-C14290",
    "accountId": "0012E00002dzucpQAA",
    "customerCabinet": "550.09.16",
    "customerPanelName": "550.09.16.PNL 01",
    "customerPortId": "98",
    "customerLabel": null,
    "interconnectionPanel": "550.09.12.RU21",
    "interconnectionPortId": "98",
    "interconnectionPortStatus": "In-Service",
    "portComment": null,
    "mediaType": "Fiber",
    "serviceLevel": "Connectivity-Standard",
    "connectedTo": "Megaport (USA) Inc.",
    "caseNumber": "00782459",
    "installDate": "2022-05-26 12:05:00",
    "orderingParty": "Service Fabric",
    "circuitId": "SCCSMF00782459",
    "carrierCircuitId": "8296df65 (106222)",
    "zPanelId": "130.11.200.29",
    "zPortNo": "46"
}

 

Payload Description

Field Name Type Description
id string(20) Identifier of the Cross Connect.
site string(6) Data Center Site Code.
location string Allocated location
billingAccountNumber string(45) Customer Business Account Number.
accountId string Customer account identifier.
customerCabinet string(4k) Customer Cabinet Name.
customerPanelName string(80) Customer Panel Name.
customerPortId string(4k) Customer Port Number.
customerLabel string(80) Customer Label.
interconnectionPanel string(80) Cross Connect Interconnection Panel Identifier.
interconnectionPortId string(4k) Cross Connect Interconnection Port Number.
interconnectionPortStatus string(enum) Status of Cross Connect Interconnection Port.
values: [Pre-Wired, Available, In-Service]
portComment string(80) Port Comment.
mediaType string(enum) Cross Connect Physical Medium.
values: [Ethernet, Fiber, DS1]
serviceLevel string(enum) Cross Connect Product Type.
values: [Connectivity-Standard, Connectivity-Prem, Connectivity-ICC, Connectivity-SLXCT]
connectedTo string(255) Cross Connect Z-end Customer Name.
caseNumber string(64) Work Order Case Number.
installDate string(date) Cross Connect Installation Date.
orderingParty string(255) Is Customer the Ordering Party.
circuitId string(100) Cross Connect Circuit Identifier.
carrierCircuitId string(10) Cross Connect Z-end Carrier Circuit Identifier.
zPanelId string Z-end Customer Panel Identifier.
zPortNo string Z-end Customer Port Number

6. Get Cross Connect Information by Site

Retrieve a List of Cross Connects By Site

The method can be used to retrieve the cross connect inventory of the customers account. 

 Method GET
End point /v2/cross-connect-inventory?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/v2/cross-connect-inventory?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 false string(6) Site Id
size false integer The maximum number of search results to return.
Default value: 25
page false integer The page number of the returning search results.
Default value: 0

 

Body

n/a

Sample JSON Response

{
    "content": [
        {
            "id": "ZR0D02Q2HCCQY7",
            "site": "LAX010",
            "billingAccountNumber": "130-C14290",
            "accountId": "0012E00002dzucpQAA",
            "interconnectionPanel": "550.09.12.RU21",
            "interconnectionPortId": "98",
            "interconnectionPortStatus": "In-Service",
            "mediaType": "Fiber",
            "zPanelId": "130.11.200.29",
            "zPortNo": "46"
        }
    ],
    "pageable": {
        "last": false,
        "totalPages": 41,
        "totalElements": 1007,
        "size": 25,
        "number": 0,
        "numberOfElements": 25,
        "first": true,
        "empty": false
    }
}

 

Payload Description

Field Name Type Description
id string Identifier of the Cross Connect.
site string(6) Data Center Site Code.
billingAccountNumber string(45) Customer Business Account Number.
accountId string Customer account identifier
interconnectionPanel string(80) Cross Connect Interconnection Panel Identifier.
interconnectionPortId string(4k) Cross Connect Interconnection Port Number.
interconnectionPortStatus string(enum) Status of Cross Connect Interconnection Port.
values: [Pre-Wired, Available, In-Service]
mediaType string(enum) Cross Connect Physical Medium.
values: [Ethernet, Fiber, DS1]
zPanelId string Z-end Customer Panel Identifier.
zPortNo string Z-end Customer Port Number.

Response Codes


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


Need Help?

Have not found what you are looking for, please do not hesitate to reach out to us!

FAQs
Contact Us
globe