Commands
| Action | URL | Method |
|---|---|---|
| List your endpoints | /users/{user_id}/endpoints | GET |
| Show info for an endpoint | /users/{user_id}/endpoints/{endpoint_id} | GET |
| Create a new endpoint | /users/{user_id}/endpoints | POST |
| Update an endpoint | /users/{user_id}/endpoints/{endpoint_id} | PUT |
| Delete/cancel endpoint | /users/{user_id}/endpoints/{endpoint_id} | DELETE |
| Re-activate a cancelled endpoint | /users/{user_id}/endpoints/{endpoint_id}/activate | PUT |
Endpoint Fields
- id
- An integer that uniquely identifies the endpoint.
- name
- The name of the endpoint.
- description
- A description of the endpoint.
- ip-address
- The IP address or domain of the endpoint.
- created-at
- The date and time the endpoint was created.
- deleted-at
- The date and time the endpoint was cancelled. If this is nil, then the endpoint has not been deleted/cancelled yet.
List your endpoints
GET http://voipspear.com/users/{user_id}/endpoints
By default, this returns all active endpoints for your account. However, you can use the following parameters to constrain the search.
- name
- The name of the endpoint. This is a case-insensitive partial match.
- ip_address
- The IP address address of the endpoint. This is a case-insensitive partial match.
- deleted
- If this parameter is included, the list of endpoints will include deleted/cancelled endpoints.
Some examples of this would be:
GET http://voipspear.com/users/{user_id}/endpoints?name=server
GET http://voipspear.com/users/{user_id}/endpoints?deleted
GET http://voipspear.com/users/{user_id}/endpoints?deleted&ip_address=127.0.0.1
Example
Show info for an endpoint
GET http://voipspear.com/users/{user_id}/endpoints/{endpoint_id}
Example
Create new endpoint
POST http://voipspear.com/users/{user_id}/endpoints %>
Response Code: 201 Created
When you create an endpoint, you should expect that the response code is "201 Created" rather than the usual "200 OK". Also note that the response headers also include the location/URL of the newly created endpoint. And don't forget: after you create an endpoint, you must create VoIP tests for it. Otherwise, none of the servers will test to the new endpoint.
Here are the fields you can specify when creating an endpoint.
- name
- The name of this endpoint. The endpoint's name can be whatever you please and there are no restrictions on the characters you can use.
- ip_address
- The IP address of the endpoint, or a domain name that VoIP Spear resolves to an IP address.
- description
- A description for the endpoint. The endpoint's description can be whatever you please and there are no restrictions on the characters you can use.
Example
Update an endpoint
PUT http://voipspear.com/users/{user_id}/endpoints/{endpoint_id}
The fields you may specify when updating an endpoint are similar to creating a new endpoint. The only difference is that you cannot change the IP address of the endpoint after it is created.
- name
- The name of this endpoint. The endpoint's name can be whatever you please and there are no restrictions on the characters you can use.
- description
- A description for the endpoint. The endpoint's description can be whatever you please and there are no restrictions on the characters you can use.
Example
Delete an endpoint
DELETE http://voipspear.com/users/{user_id}/endpoints/{endpoint_id}
Deleting an endpoint does not remove it from the system entirely. Instead, it goes into an inactive state. This is why we prefer to use the term "cancelled" as opposed to "deleted." Note that you are able to re-activate a deleted/cancelled endpoint later on.
Inactive endpoints are not monitored by the servers.
Example
Re-activate a cancelled endpoint
PUT http://voipspear.com/users/{user_id}/endpoints/{endpoint_id}/activate
Example