Usage

Interact with the Netzo API.

To make requests to the Netzo API, replace the RESOURCE placeholder with a valid one from the list above, and the NETZO_API_KEY placeholder with a valid API key.

find

Retrieves a list of all matching resources.

curl -H "x-api-key: NETZO_API_KEY" -X GET https://api.netzo.io/RESOURCE
fetch('https://api.netzo.io/RESOURCE', {
  method: 'GET',
  headers: { 'x-api-key': 'NETZO_API_KEY' },
})
Sample Response Here is how a sample response could look like:
{
  "total": 2,
  "limit": 25,
  "skip": 0,
  "data": [{...}, {...}]
}

Notice the data array returns an array of resources and is wrapped by additional pagination information.

get

Retrieve a single resource.

curl -H "x-api-key: NETZO_API_KEY" -X GET https://api.netzo.io/{resource}/{_id}
fetch('https://api.netzo.io/{resource}/{_id}', {
  method: 'GET',
  headers: { 'x-api-key': 'NETZO_API_KEY' },
})
Sample Response Here is how a sample response could look like:
{...}

Notice how the resource is returned directly (no pagination).

create

Create a new resource (optionally with auto-generated ID).

curl -H "x-api-key: NETZO_API_KEY" -d '{...}' -X POST https://api.netzo.io/{resource}/{_id}
fetch('https://api.netzo.io/{resource}/{_id}', {
    method: 'POST',
    headers: { 'x-api-key': 'NETZO_API_KEY' },
    body: JSON.stringify({...})
})
Sample Response Here is how a sample response could look like:
{...}

Notice how the resource is returned directly (no pagination).

Some resources don't support create for multiple entries from an array.

update

Completely replace a single or multiple resources.

curl -H "x-api-key: NETZO_API_KEY" -d '{...}' -X PUT https://api.netzo.io/{resource}/{_id}
fetch('https://api.netzo.io/{resource}/{_id}', {
    method: 'PUT',
    headers: { 'x-api-key': 'NETZO_API_KEY' },
    body: JSON.stringify({...})
})
Sample Response Here is how a sample response could look like:
{...}

Notice how the resource is returned directly (no pagination).

update is normally expected to replace an entire resource which is why for multiple records only patch is supported.

patch

Merge the existing data of a single with the new data.

curl -H "x-api-key: NETZO_API_KEY" -d '{...}' -X PATCH https://api.netzo.io/{resource}/{_id}
fetch('https://api.netzo.io/{resource}/{_id}', {
    method: 'PATCH',
    headers: { 'x-api-key': 'NETZO_API_KEY' },
    body: JSON.stringify({...})
})
Sample Response Here is how a sample response could look like:
{...}

Notice how the resource is returned directly (no pagination).

Some resources don't support patch for multiple entries from an array.

remove

Remove a single or multiple resources.

curl -H "x-api-key: NETZO_API_KEY" -X DELETE https://api.netzo.io/{resource}/{_id}
fetch('https://api.netzo.io/{resource}/{_id}', {
  method: 'DELETE',
  headers: { 'x-api-key': 'NETZO_API_KEY' },
})
Sample Response Here is how a sample response could look like:
{...}

Notice how the resource is returned directly (no pagination).

Some resources don't support remove for multiple entries from an array.