Overview

HTTP API that powers the Netzo Platform.

The Netzo Platform is powered by the Netzo API. An API-first approach allows interacting with the Netzo Platform programmatically and integrating Netzo with other services. The Netzo API is the foundation for the Netzo CLI and Netzo API Client.

You can use the Netzo API client for easily interacting with the Netzo API in JavaScript/TypeScript.

Authentication

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

Resources

The following resources are available at the specified path and for the specified methods. For a more in depth API reference check-out the OpenAPI Reference for the Netzo API.

authentication

Authenticate with the Netzo API.

  • Path: /authentication
  • Methods: create
  • Authentication: apiKey, jwt (internal)

users

Users are people with accounts and access to the Netzo Platform.

  • Path: /users
  • Methods: find, get, create, patch, remove
  • Authentication: apiKey, jwt (internal)

workspaces

Workspaces are top-level containers that own organization resources.

  • Path: /workspaces
  • Methods: find, get, patch, remove
  • Authentication: apiKey, jwt (internal)

api-keys

API keys are used to authenticate with the Netzo API.

  • Path: /api-keys
  • Methods: find, get, create, patch, remove
  • Authentication: apiKey, jwt (internal)

audit-logs

Audit logs are used to track user activity.

  • Path: /audit-logs
  • Methods: find, get, create
  • Authentication: apiKey, jwt (internal)

deployments

Deployments are used to deploy projects.

  • Path: /deployments
  • Methods: find, get, create
  • Authentication: apiKey, jwt (internal)

requests

Requests are used to make HTTP requests.

  • Path: /requests
  • Methods: find, get, create
  • Authentication: apiKey, jwt (internal)

projects

Projects are used to manage code and resources.

  • Path: /projects
  • Methods: find, get, create, patch, remove
  • Authentication: apiKey, jwt (internal)

workspace-users

Workspace users are used to manage workspace access.

  • Path: /workspace-users
  • Methods: find, get, create, patch, remove
  • Authentication: apiKey, jwt (internal)