In This Document
Was this document useful?
Have a suggestion for the Armor Knowledge Base? Send a message to email@example.com.
The interactive Armor API tool, powered by Swagger, is a cloud-based tool used to build, deploy, and document APIs. You can this tool to test and review the API calls before you implement the calls.
The interactive Armor API is divided into five sections:
- Network Services
- Account Management
Access the interactive Armor API
To use the interactive Armor API, you must first authenticate into the tool with your account credentials and keys.
There are two ways to authenticate into the tool:
- Via the API tool and AMP
- Via the command line
Via Swagger and AMP
- Access the interactive Armor API.
- Click Authentication.
- Click /auth/authrotize.
- On the right side, under Data Type, click the Example Value box.
- This will populate the empty field on the left.
- Click Try it out!
- Under Response Body, copy the code, including the equal sign ( = ).
- Locate and select /auth/token.
- Under Data Type, click the Example Value box.
- Paste your code into the field on the left.
- Click Try it out!
- This will display the access_token.
- Copy the access_token.
- Scroll up, and then in the Authorization field, enter FH-AUTH, followed by the copied access_token.
- FH-AUTH afecb03c3de8654
- Access the Armor Management Portal (AMP).
- On the left-side navigation, click Account.
- In the Overview screen, copy the number in Account Number.
- Return to the interactive Armor API.
- In the X-Account_Context field, enter the copied Account Number.
- Click Authorize.
- (Optional) You can click Authentication, and then click Get / me to find the account number for your other accounts.
Via the command line how to handle a user with multiple accounts
Enter the login information for the Armor Management Portal (AMP). Review the following example.
If the authentication is successful, you will receive the authorization code (code). Review the following example.
Redeem the authorization code (code) to retrieve the access token and ID token. Review the following example.
If the request is successful, you will receive the access token (access_token) and the X-Account-Context (id_token). Copy this information. Review the following example.
- Go to apidoc.tde.armorlabs.co.
- In Authorization, enter the access token (access_token).
- In X-Account-Context, enter the ID for the account.
- You can use the GET API to find the account ID (id)
- Click Authorize. You can now use the form to locate and test API calls before you enter the command line.
Add input parameters to Put, Post, Delete, and Get
This section only applies to API call that require input parameters.
- Click the desired API section (Authentication, Infrastructure, Network Services, Security, Support, and Account Management), and then click the desired API call.
- On the right, under Data Type, click Example Value, and then click the example to populate the blank filed under Value.
- On the left, under Value, make your desired changes.
- The Parameter content type field must be configured to JSON.
- Click Try it out! The fields below will populate with your added changes, including the expected results. You can copy these fields and paste the information into the command line.
For more information on the Armor APIs, see Armor API Guide.
For more information on the Swagger product, please visit the Swagger website.