Skip to content

API Guide

All functionality provided by NetOrca is available through the API.

The API itself has two main contexts:

  • consumer
  • serviceowner

These contexts will determine the operation of each endpoint.

The general format of the API endpoints are as follows:

{netorca_url}/v1/{context}/{object}

Future breaking releases of the NetOrca platform will publish the API under a new version endpoint. i.e. 'v2'

Calls to the API

This section will give a brief overview on authenticating and making calls to the API in NetOrca.

Authentication

The NetOrca API supports api-key based authentication.

Please first generate an API Key for your team. Described here

This API key will then need to be used in the headers of any calls made to NetOrca in the following format:

{
  "Authorization": "Api-Key {{ api_key_value}}"
}