ServiceFabric® API – Getting Started#

This section will explain how to retrieve an API key from the ServiceFabricTM Portal for use with ServiceFabricTM API supports an interactive UI that can be found at https://api.servicefabric.digitalrealty.com/docs, which can be used to demonstrate authentication and port retrieval.

Obtain API Key for Authentication#
  1. Go to ServiceFabricTM Portal (ServiceFabric® (digitalrealty.com) and login.
  2. Go to the top right corner, click on your name.
  3. Click on “Manage API Key.
  4. Click on “New API Key”.
  5. Copy Key and Secret (once pop-up is closed the Secret is unable to retrieve).
  6. Logout of ServiceFabricTM.
Trying out the API: Getting Authorized#
  1. Go to https://api.servicefabric.digitalrealty.com/docs
  2. Scroll down to “Authentication” section and click POST.
  3. Click “Try it out”.
  4. Replace the second “password” (keeping the quotes) with the Secret and replace the second “username” (keeping the quotes) with the Key.
  5. Click “Execute”.
  6. Scroll down to Response body and Copy “Access token”.
  7. Scroll to the top of the page to create access to APIs.
  8. Click “Authorize”.
  9. Enter the “Access Token”.
  10. Click “Authorize”.
  11. Close Pop-Up.
  12. Utilize APIs on screen.

You are now authorized and ready to perform various API tasks, such as create, read, and update your ServiceFabricTM resources. Continue reading for an example on how to read the list of ports in your Inventory.

Trying out the API: List of Organizations#
  1. Go to https://api.servicefabric.digitalrealty.com/docs
  2. Go to “Organization” section.
  3. Click on “Try it out”.
  4. Specify any desired parameters, such as sort order or page size.
  5. Click “Execute”.
  6. View Results in “Server response” section.
Trying out the API: List of Ports#
  1. Go to https://api.servicefabric.digitalrealty.com/docs
  2. Go to “Port” section.
  3. Click on “Try it out”.
  4. Copy “id” from Server results (list of organizations above) into Organization ID.
  5. Specify any desired parameters, such as sort order or page size.
  6. Click “Execute”.
  7. View Results in “Server response” section.