Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Northflank Addons API

The Addons API from Northflank — 2 operation(s) for addons.

Northflank Addons API is one of 4 APIs that Northflank publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Addons. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.northflank.com/v1.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.northflank.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Northflank Addons API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Addons 4
GET
/projects/{projectId}/addons
List addons in a project
listAddons 1 param → 200
POST
/projects/{projectId}/addons
Create an addon
createAddon 1 param body → 200
GET
/projects/{projectId}/addons/{addonId}
Get an addon
getAddon 2 params → 200
DELETE
/projects/{projectId}/addons/{addonId}
Delete an addon
deleteAddon 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is GenericListResponse (1 property). Each schema is shown below with its type and property counts.

GenericObject
object
GenericListResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

northflank-addons-api-openapi.yml Raw ↑

Other APIs Northflank publishes across the network.

Northflank Jobs API
Northflank Projects API
Northflank Services API