Test API keys

Intro

Test API keys can be used to try out the API for most endpoints. They can be generated programmatically or through on the site.

Test API keys carry the following restrictions:

  • Only 1000 requests are permitted per 24 hour period.
  • Only requests from the IP address that generated the key will be accepted.

Test API keys object

Sample object

{
    "type": "test_api_key",
    "id": "5071aa5f-3b4a-4d42-bab4-feccc6267a64",
    "key": "test_lOzu4xm6GkrnWNkBB3iNAhk6Zj4omggan97jrTTp",
    "ip": "1.2.3.4",
    "created": 1552439510253
}

Attributes

typestring

String representing object type.

always value: "test_api_key"
idstring

Unique identifier for object.

keystring

Unique key string used to authenticate API requests.

ipstring

IP address that generated the key. Key will only work for requests from this IP.

creatednumber

Timestamp of object creation in milliseconds.

Endpoints

Get a test API key

Get a test API key for request IP address. This endpoint has no cost and does not require an API key.

GET/account/test-api-keys

Examples

Example Request
curl -s "https://api.nettoolkit.com/v1/account/test-api-keys"
Example Response
{
    "code": 1000,
    "results": [
        {
            "type": "test_api_key",
            "id": "5071aa5f-3b4a-4d42-bab4-feccc6267a64",
            "key": "test_lOzu4xm6GkrnWNkBB3iNAhk6Zj4omggan97jrTTp",
            "ip": "1.2.3.4",
            "created": 1552439510253
        }
    ]
}