URL structure
All Namikoda API URLs currently have the same structure:
https://api.namikoda.com/v1/<owner>/<resource>/<id>
The most common owner is "public" which is accessible to all accounts. The "public" owner has a single resource called "ipsfor" that contains IP address information for a given ID. The list of available IDs in the public "ipsfor" resource is on the sites available page.
IPsFor Resource structure
Both JSON and XML responses have the same structure. The example here will use JSON.
{
"ipv4s": [
"192.30.252.0/22"
],
"ipv6s": [
"2620:112:3000::/44"
],
"lastUpdate": "2017-02-11T22:55:49.543Z",
"name": "Github webhooks",
"owner": "public",
"id": "github",
"value": [
"192.30.252.0/22",
"2620:112:3000::/44"
]
}
ipv4s
This is an array of string values describing the IPv4 CIDR blocks that make up the record.
ipv6s
This is an array of string values describing the IPv6 CIDR blocks that make up the record.
lastUpdate
This is a string value representing a timestamp in ISO-8601 format. It represents the last time that the data was changed in Namikoda's system.
name
This is a string value representing a human-readable name for the resource.
owner
This is a string value representing the user or organization that owns the data. The two most frequently encountered are "public" and whatever owner you set up in https://manage.namikoda.com.
id
This is a string value representing the unique identifier of the resource.
value
This is an array of string values describing all of the combined IPv4 and IPv6 CIDR blocks that make up the record. It's a concatenation of the ipv4s
and ipv6s
values above.