Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Request Digital LOA

Request a Digital Letter of Authorization (LOA) from a third-party and use it to establish a Cross Connect interconnection.

diloa-request-workflow

Step 1: Authenticate​

Submit your user credentials, Client ID, and Client Secret for OAuth2 authentication.

 

Refer to Generating Client ID and Client Secret under Getting Access Token section for instructions on how to create client ID and client secret and refer to Requesting Access and Refresh tokens for instructions on how to call Oauth API to validate and authenticate your credentials.

 

If you are unaware of your user credentials for Equinix Customer Portal, contact your local Equinix Service Desk. 


Step 2: Get Possible Z-side Partners​

Use the Get Possible Partner Organizations API request to establish potential Z-side partners present in a given IBX data center.

 GET /diloa/v1/organizations
MethodGET
Endpoint/diloa/v1/organizations
HeadersAuthorization
Path ParametersNot applicable
Query Parametersibx
Body ParametersNot applicable

Sample curl request

curl -X
GET "https://api.equinix.com/diloa/v1/organizations?ibx=AM11"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"

Query parameters

Parameter
Description
ibx string
REQUIRED		IBX data center identifier.
Example: AM11

Sample response:

[
    {
        "orgIds": [
            "81918"
        ],
        "name": "Michael Scott Paper Company"
    },
    {
        "orgIds": [
            "9769",
            "10947",
            "11070",
            "69273",
            "78488"
        ],
        "name": "Dunder Mifflin Inc."
    },
    {
        "orgIds": [
            "24254"
        ],
        "name": "Serenity by Jan"
    }
]

Step 3: Create Digital LOA Request​

Use the Create Digital LOA Request API request to request a Digital LOA document from a given service provider.

 POST /diloa/v1/digitalLoas/loaRequest
MethodPOST
Endpoint/diloa/v1/digitalLoas/loaRequest
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parametersibx, requestedNumber, requestor, provider, notes

Sample curl request - a known service provider

curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/loaRequest"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "ibx": "CH1",
    "requestedNumber": 2,
    "requestor": {
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "CUSTOMER_ORGANIZATION",
        "orgIds": [
          "123456"
        ],
        "name": "Michael Scott Paper Company",
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "notes": "No additional notes"
}'

Sample curl request - a new service provider relationship

curl -X
POST "https://api.equinix.com/diloa/v1/digitalLoas/loaRequest"
-H "content-type: application/json"
-H "Authorization: Bearer qwErtY8zyW1abcdefGHI"
-d '{
    "ibx": "CH1",
    "requestedNumber": 2,
    "requestor": {
        "contacts": [
            {
                "type": "NOTIFICATION",
                "registeredUser": "Registered",
                "firstName": "John",
                "lastName": "Smith",
                "timezone": "Australia/Perth",
                "availability": "ANYTIME",
                "details": [
                    {
                        "note": "new email address",
                        "value": "kyle@mail.com",
                        "type": "EMAIL"
                    }
                ]
            }
        ]
    },
    "provider": {
        "type": "NEW_RELATIONSHIP",
        "email": "mike@mspc.us",
        "name": "Michael Scott Paper Company"
    },
    "notes": "No additional notes"
}'

Body parameters

Parameter
Description
ibx string
REQUIRED		IBX data center identifier.
Example: AT1
requestedNumber integer
REQUIRED		Number of requested connections.
Minimum: 1
Maximum: 10
requestor object
REQUIRED		Digital LOA document requestor information.
contacts array[object]
REQUIRED
Service provider contact information.
type string
Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
OPTIONAL
contactId, userId or userKey of a registered user.
firstName string
CONDITIONAL
Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
CONDITIONAL
Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
OPTIONAL
Contact person's timezone.
Example: Australia/Perth
availability string
OPTIONAL
Contact person's availability.
Applicable values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
REQUIRED
Means of contact.
note string
OPTIONAL
Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
REQUIRED
Value specific to the given contact type.
Example: jane@smith.com
type string
REQUIRED
Means of contact.
Applicable values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
provider objectProvider details.
type string
REQUIRED
Party type that specifies if the provider is a known organization or a new one without previous engagements.
Applicable values:
  • CUSTOMER_ORGANIZATION - A customer organization with known organization identifiers.
  • NEW_RELATIONSHIP - A new customer relationship, where the organization identifier is unknown.
email string
CONDITIONAL
Customer organization representative's email address. Required if the provider.type parameter is set to NEW_RELATIONSHIP.
Example: mike@mspc.us
orgIds array[string]
CONDITIONAL
Customer organization identifiers. Required if the provider.type parameter is set to CUSTOMER_ORGANIZATION.
Example: 123345
name string
REQUIRED
Customer organization name.
Example: Solid Snake Inc.
contacts array[object]
REQUIRED
Service provider contact information.
type string
Notification messages category relevant to a given contact person.
Possible values:
  • NOTIFICATION - Notifications related to Digital LOA document's lifecycle.
  • TECHNICAL - Contact information for technical inquiries.
registeredUser string
OPTIONAL
contactId, userId or userKey of a registered user.
firstName string
CONDITIONAL
Contact person's first name. Required if registeredUser hasn't been provided.
Example: Jane
lastName string
CONDITIONAL
Contact person's last name. Required if registeredUser hasn't been provided.
Example: Smith
timezone string
OPTIONAL
Contact person's timezone.
Example: Australia/Perth
availability string
OPTIONAL
Contact person's availability.
Applicable values:
  • WORK_HOURS - Contact person be reached during working hours.
  • ANYTIME - Contact person can be reached anytime throughout the day.
details array[object]
REQUIRED
Means of contact.
note string
OPTIONAL
Additional note applicable to the given contact option.
Example: Not suitable for emergencies.
value string
REQUIRED
Value specific to the given contact type.
Example: jane@smith.com
type string
REQUIRED
Means of contact.
Applicable values:
  • EMAIL - Email address.
  • PHONE - Landline phone number.
  • MOBILE - Mobile phone number.
  • SECONDARY_EMAIL - Alternative email address.
notes string
OPTIONAL		Additional information to be considered.
Example: No additional notes.