This article is for API V1, please use the Developer Center for API V2 guides.
Mission Control API: Connection authorized IP's
Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.
In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.
Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with(and who we are).
For how to do this, please refer to our article on "Authentication and Tokens" after updating your credentials you can follow on from here.
In this article you will learn how to:
- Get your Authorized IPs
- Create an Authorized IP
- Delete an Authorized IP
- Update an Authorized IP
Get your Authorized IP:
This endpoint returns the authorized IPs associated with your account connections. There are 2 parameters, simply fill these in with the amount of pages you would like returned & the amount of result per page. Once you've done that, hit "Try It Out".
You will recieve a JSON response similar to the above with the details of all the Authorized IPs associated with you connections.
Create an new Authorized IP:
We can use the create a new Authorized IP endpoint to add a new Authorized IP to one of our IP connections. If we navigate to the endpoint there will be an example of the JSON body on the right hand side. Click this to copy it into your parameters box. The fields "connection_id" and "ip_address" are mandatory. Edit your message body with your new Authorized IP details.
Once your ready hit "TRY IT OUT", you should get a response similar to the one below:
Delete an Authorized IP:
We can use the delete an Authorized IP endpoint to delete an Authorized IP from one of our connections. In order to delete the Authorized IP, we will need to pass the address ID as the parameter. If you do not have your Authorized IP ID, you can acquire it by using the "Get your Authorized IP" endpoint above. Once you have you ID, enter it into the "id" box and click "TRY IT NOW".
You will get a response similar to the one below letting you know if you request was successful or not.
Update an Authorized IP:
The update an Authorized IP endpoint allows you to change the details of an existing Authorized IP on one of your connections. Firstly enter the "id" of the Authorized IP you want to update in the "id" parameter box. Next, prepare the JSON message body for the authorized_ip parameter with the updated Authorized IP information. When you are ready, click "TRY IT OUT".
If you are successful you will receive a JSON response with the updated Authorized IP details similar to the one below:
Can't find what you're looking for? Click the chat bubble at your lower right-hand corner and start a chat!