Skip to main content
Index

Resellers (V2)

Resellers (V2) API allows an authenticated user from a reseller organization with the required permissions to do retrieve reseller and customer accounts summaries, retrieve and update reseller customer details, and create and delete a reseller customer.

 

To create a reseller customer, refer to Create new customer account (V2) under the the How to Guide section. All other methods can be found below.

GET Resellers

GET /resellers

 Method  GET
 URL or End Point  /v2/resellers
 Headers  Authorization, Content-Type
 Query Parameters  offset, limit
 Body  Not applicable

 

This method retrieves a list of reseller accounts in your organization. Only an authenticated user from your organization may view this list. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response for this API. 

 

curl -X

GET "https://api.equinix.com/v2/resellers?offset=4&limit=2"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the query parameters is as follows:

 

Query Parameter Name

Mandatory Type Example Description
offset No integer 4

Defines the index of the first item returned in the response. By specifying the offset, the response returns a subset of records starting with the offset value.

For example, if the offset is 10, the starting item returned in the response would be the 11th item. 

 

Default value: 0.

limit No integer 2

Defines the maximum number of items returned per page. 

 

Default value: 10.

Limit: 1 to 100. 

 

{
  "data": [
    {
      "accountNumber": "123456",
      "accountName": "ACME CORP",
      "accountType": "RESELLER",
      "ibxs": [
        "CH1",
        "DC5"
      ]
    },
    {
      "accountNumber": "789101",
      "accountName": "ACME LTD.",
      "accountType": "RESELLER",
      "ibxs": [
        "TR1"
      ]
    }
  ],
  "pagination": {
    "offset": 4,
    "limit": 2,
    "total": 17,
    "next": "/resellers?limit=2&offset=6",
    "previous": "/resellers?limit=2&offset=2"
  }
}

 

The description of the response payload is as follows:

 

Field name

Type Example Description
data array
[objects]
 

Data returned from your query. Each reseller account object comprises the following fields: accountNumber, accountName, accountType, ibxs.

accountNumber string 123456

Your reseller account number.

 

This number is important when calling reseller account specific APIs.

accountName string ACME CORP

Your reseller account name.

accountType string RESELLER

Type of account. 

Account type - Description

RESELLER - Reseller account.

ibxs

array 

[strings]

CH1,

DC5

List of IBX data centres where this account has presence.

For example, if the account has CH1 and DC5 in their list of IBXs, this means that the account is present in the IBXs CH1 in Chicago and DC5 in Washington DC.

pagination object   Pagination information. This object comprises the following fields: offset, limit, total, next, previous.
offset integer 4

Offset of the first item in the response, as defined in the query parameter 'offset'.

limit integer 2

Maximum number of items in the response, as defined in the query parameter 'limit'.

total integer 17

Total number of available items in the record.

next string /resellers?limit=2&offset=6

URL for the next page of results.

previous

string

/resellers?limit=2&offset=2

URL for the previous page of results.

 

If you get “Insufficient permissions” error, contact your Master Administrator.

GET Resellers {accountNumber} Customers

GET /resellers/{accountNumber}/customers

 Method  GET
 URL or End Point  /v2/resellers/{accountNumber}/customers
 Headers  Authorization, Content-Type
 Query Parameters  offset, limit
 Body  Not applicable

 

This method retrieves a list of customers for a specific reseller account in your organization. Only an authenticated user who is a Master Administrator in your organization may view this list. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response for this API. 

 

curl -X

GET "https://api.equinix.com/v2/resellers/123456/customers?offset=4&limit=2"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the URL parameter is as follows:

 

URL Parameter Name

Mandatory Type Example Description
accountNumber Yes string 123456

Your reseller account number.

 

The description of the query parameters is as follows:

 

Query Parameter Name

Mandatory Type Example Description
offset No integer 4

Defines the index of the first item returned in the response. By specifying the offset, the response returns a subset of records starting with the offset value.

For example, if the offset is 10, the starting item returned in the response would be the 11th item. 

 

Default value: 0.

limit No integer 2

Defines the maximum number of items returned per page. 

 

Default value: 10.

Limit: 1 to 100. 

 

{
  "data": [
    {
      "customerAccountNumber": "567123",
      "customerAccountName": "Acme Corp 1",
      "status": "ACTIVE",
      "accountNumber": "123456"
    },
    {
      "customerAccountNumber": "890123",
      "customerAccountName": "Acme Corp 2",
      "status": "PENDING",
      "accountNumber": "123456"
    }
  ],
  "pagination": {
    "offset": 4,
    "limit": 2,
    "total": 17,
    "next": "/customers?limit=2&offset=6",
    "previous": "/customers?limit=2&offset=2"
  }
}

 

The description of the response payload is as follows:

 

Field name

Type Example Description
data array
[objects]
 

Data returned from your query. Each customer account object comprises the following fields: customerAccountNumber, customerAccountName, status, accountNumber.

customerAccountNumber string 567123 Your customer's account number.
customerAccountName string Acme Corp 1

Your customer's account name.

status string ACTIVE

Status of your customer's account.

 

Status - Descriptions
PENDING - Customer account is submitted for creation and will soon be active.
ACTIVE - Customer account is active and ready for orders.

accountNumber

string

123456

Reseller account number that this customer is associated with.

pagination object   Pagination information. This object comprises the following fields: offset, limit, total, next, previous.
offset integer 4

Offset of the first item in the response, as defined in the query parameter 'offset'.

limit integer 2

Maximum number of items in the response, as defined in the query parameter 'limit'.

total integer 17

Total number of available items in the record.

next string /customers?limit=2&offset=6

URL for the next page of results.

previous

string

/customers?limit=2&offset=2

URL for the previous page of results.

 

If you get “Insufficient permissions” error, contact your local Equinix Service Desk. 

GET Customers {customerAccountNumber}

GET /resellers/{accountNumber}/customers/{customerAccountNumber}

 Method  GET
 URL or End Point  /v2/resellers/{accountNumber}/customers/{customerAccountNumber}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

This method retrieves the details of a specific customer in your reseller account. Only an authenticated user who is a Master Administrator in your organization may retrieve reseller customer details. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshots show a sample curl request and JSON response for this API. 

 

curl -X

GET "https://api.equinix.com/v2/resellers/123456/customers/567123"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

The description of the URL parameters is as follows:

 

URL Parameter Name

Mandatory Type Example Description
accountNumber Yes string 123456

Your reseller account number.

customerAccountNumber Yes string 567123 The customer account number.

 

{
  "accountNumber": "123456",
  "status": "ACTIVE",
  "customerAccountNumber": "567123",
  "customerAccountName": "Acme Corp 1",
  "resellerNotificationContact": "janedoe123",
  "permittedServices": [
    "NETWORK_EDGE"
  ],
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "#10-11",
    "city": "Main City",
    "state": "California",
    "countryCode": "US",
    "zipCode": 91024
  }
}

 

The description of the response payload is as follows:

 

Field name

Type Example Description
accountNumber string 123456 Reseller account number that this customer is associated with.
status string ACTIVE

Status of your customer's account.

 

Status - Descriptions
PENDING - Customer account is submitted for creation and will soon be active.
ACTIVE - Customer account is active and ready for orders.

customerAccountNumber string 567123 Your customer's account number.
customerAccountName string Acme Corp 1

Your customer's account name.

resellerNotificationContact string janedoe123

Equinix-registered username of your organization's Equinix Customer Portal user who is the notification contact for your customer.

permittedServices array
[strings]
NETWORK_EDGE Allows customers' users to view permissions for specified services.

Permitted Services - Description
NETWORK_EDGE - Allows customers' users to view permissions related to Network Edge.
address object   Customer address. This object comprises the following fields: addressLine1, addressLine2, city, state, countryCode, zipCode, permittedServices. 
addressLine1 string 123 Main Street Line 1 of the customer address. 
addressLine2 string #10-11 Line 2 of the customer address. 
city string Main City City.
state string California State.
countryCode string US

Country code. 

zipCode string 91024 Postal code or zip code.

 

If you get “Insufficient permissions” error, contact your local Equinix Service Desk. 

PATCH Customers {customerAccountNumber}

PATCH /resellers/{accountNumber}/customers/{customerAccountNumber}

 Method  PATCH
 URL or End Point  /v2/resellers/{accountNumber}/customers/{customerAccountNumber}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  Not applicable

 

This method updates the details of a specific customer in your reseller account. Only an authenticated user who is a Master Administrator in your organization may do so. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshot shows a sample curl request to update all the applicable fields in a customer's profile. 

 

curl -X

PATCH "https://api.equinix.com/v2/resellers/123456/customers/567123"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "customerAccountName": "Acme Corp 1",
  "resellerNotificationContact": "janedoe123",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "#10-11",
    "city": "Main City",
    "state": "California",
    "countryCode": "US",
    "zipCode": 91024
  },

  "permittedServices": [
    "NETWORK_EDGE"
  ]
}

 

The description of the URL parameters is as follows:

 

URL Parameter Name

Mandatory Type Example Description
accountNumber Yes string 123456

Your reseller account number.

customerAccountNumber Yes string 567123 The customer account number.

 

The description of the body parameters is as follows:

 

When 'Conditional' is indicated for a Body Parameter, refer to Description for further details.

 

Body
Parameter Name

Mandatory Type Example Applicable Values Description
customerAccountName No string Acme Corp 1  

Name of your customer account. This is free text input.

Limit: 100 characters

resellerNotificationContact No string janedoe123  

Equinix-registered username of your organization's Equinix Customer Portal user, who will serve as the notification contact for your customer.

 

Only 1 username is allowed. The Equinix Customer Portal user's status must be active or locked. If the user's status is not any of these, the request will fail.

address No object     Customer address. This object comprises the following body parameters: addressLine1, addressLine2, city, state, countryCode, zipCode, permittedServices. 
addressLine1 No string 123 Main Street   Line 1 of the customer address. This is free text input. 

Limit: 1 to 100 characters.
addressLine2 No string #10-11   Line 2 of the customer address. This is free text input. 

Limit: 1 to 100 characters.
city No string Main City   City.

Limit: 1 to 100 characters.
state No string California   State.

Limit: 1 to 100 characters.
countryCode No string US

Click here for applicable values.

Country code. 

 

Format: ISO-3166 ALPHA-2 code.

zipCode No string 91024   Postal code or zip code.

Limit: 1 to 100 characters.
permittedServices No array
[strings]
 

NETWORK_EDGE

Allows customers' users to view permissions for specified services.

 

To disable any permitted service, the user should remove this string from the array. However, once the the customer's account has active assets related to this permission, this permission cannot be disabled. 


Permitted Services - Description
NETWORK_EDGE - Allows customers' users to view permissions related to Network Edge.


Your customer profile was successfully updated when an HTTP code of 202 and the following response header are returned. There is no response body. 

 

HTTP Response Header Name

Description
Location

URL of the customer account. 

 

Example: /customers/{customerAccountNumber}

 

To verify your customer account is updated, see GET Customers {customerAccountNumber} for more information.

 

If you get “Insufficient permissions” error, contact your Master Administrator.

POST Customers {customerAccountNumber} Remove

POST /resellers/{accountNumber}/customers/{customerAccountNumber}/remove

 Method  POST
 URL or End Point  /v2/resellers/{accountNumber}/customers/{customerAccountNumber}/remove
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Body  reason

 

This method removes a specific customer from your reseller account. Only an authenticated user who is a Master Administrator in your organization may remove a customer. The authorization token and content-type are the only headers that are passed to this API and a response is received based on the values passed.

 

This operation removes your customer account permanently. This cannot be reversed or undone.

 

If you are unaware of how to obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshot show a sample curl request for this method. 

 

curl -X

POST "https://api.equinix.com/v2/resellers/123456/customers/567123/remove"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

-d '{
   "reason": "Customer is no longer associated with this organization."
}

 

The description of the URL parameters is as follows:

 

URL Parameter Name

Mandatory Type Example Description
accountNumber Yes string 123456

Your reseller account number.

customerAccountNumber Yes string 567123 The customer account number you wish to delete.

 

The description of the body parameters is as follows:

 

Body
Parameter Name

Mandatory Type Example Applicable Values Description
reason Yes string Customer is no longer associated with this organization.  

Reason for deleting the customer account.

Limit: 1 to 300 characters.

 

Your customer was successfully deleted when an HTTP code of 202 and the following response header are returned. There is no response body. 

 

HTTP Response Header Name

Description
Location

URL of the customer account. 

 

Example: /customers/{customerAccountNumber}

 

To verify your customer account is removed, see GET Resellers {accountNumber} Customers for more information. 

 

If you get “Insufficient permissions” error, contact your local Equinix Service Desk.