Skip to content
On this page

Netzo API

Netzo is powered by an HTTP API that provides access to nearly every feature. The Netzo front-end web application is built on top of this API, meaning almost all its data and functionality is available through the API itself.

The following resources are available:

  • General:
    • authentication
    • users
    • workspaces
    • workspace-users
  • Workspace Resources:
    • api-keys
    • audit-logs
    • files
    • items
    • logs
    • schedules
    • services
    • projects
  • Utilities:
    • usages (internal)

For a more in depth API reference check-out api.netzo.io/docs.

Netzo SDK

Check-out the open-source Netzo SDK (@netzoio/sdk), which makes it even easier to interact programatically with the Netzo API in JavaScript/TypeScript.

Authentication

To make requests to the Netzo API, you need to provide valid authentication information. Head over to the authentication page to learn how to authenticate with the Netzo API.

Usage

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

find

Retrieves a list of all matching resources from the service.

bash
curl -H "x-api-key: API_KEY" -X GET https://api.netzo.io/RESOURCE
js
fetch('https://api.netzo.io/RESOURCE', {
  method: 'GET',
  headers: { 'x-api-key': 'API_KEY' },
})
Sample Response Here is how a sample response could look like:
json
{
  "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 from the service.

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

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

create

Create a new resource with data or multiple resources by passing in an array as data.

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

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.

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

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 or multiple resources with the new data.

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

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.

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

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

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

Netzo API has loaded