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

Unleash Addons API

Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).

Unleash Addons API is one of 36 APIs that Unleash 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 and API documentation.

This API exposes 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.0.3, at version 7.4.1.

Requests are made against a single base URL, https://app.unleash-instance.example.com.

6 operations 3 paths 10 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
7.4.1
Base URL
https://app.unleash-instance.example.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Unleash Addons API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (apiKey). It accepts HTTP bearer tokens (bearerToken). By default, every request must be authenticated.

  • apiKey — API key needed to access this API
  • bearerToken — API key needed to access this API, in Bearer token format

Paths & Operations 6

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

Addons 6

Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).

GET
/api/admin/addons
Get All Addons and Providers
getAddons → 200401
POST
/api/admin/addons
Create a New Addon
createAddon body → 200400401403413415
GET
/api/admin/addons/{id}
Get a Specific Addon
getAddon 1 param → 200401
PUT
/api/admin/addons/{id}
Update an Addon
updateAddon 1 param body → 200400401403404413415
DELETE
/api/admin/addons/{id}
Delete an Addon
deleteAddon 1 param → 200401403404
GET
/api/admin/addons/{id}/events
Get Integration Events for a Specific Integration Configuration.
getIntegrationEvents 3 params → 200401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are eventSchema (16 properties), addonTypeSchema (11 properties), addonSchema (8 properties), integrationEventSchema (7 properties). Each schema is shown below with its type and property counts.

tagSchema
object
Representation of a [tag](https://docs.getunleash.io/concepts/feature-flagstags)
3 properties 2 required
eventSchema
object
An event describing something happening in the system
16 properties 4 required
addonSchema
object
An [addon](https://docs.getunleash.io/integrate) instance description. Contains data about what kind of provider it uses, whether it's enabled or not, what eve…
8 properties 6 required
addonsSchema
object
An object containing two things: 1. A list of all [addons](https://docs.getunleash.io/integrate) defined on this Unleash instance 2. A list of all addon provid…
2 properties 2 required
integrationEventsSchema
object
A response model with a list of integration events.
1 property 1 required
addonCreateUpdateSchema
object
Data required to create or update an [Unleash addon](https://docs.getunleash.io/integrate) instance.
7 properties 4 required
addonParameterSchema
object
An addon parameter definition.
7 properties 5 required
integrationEventSchema
object
An object describing an integration event.
7 properties 7 required
tagTypeSchema
object
A tag type.
4 properties 1 required
addonTypeSchema
object
An addon provider. Defines a specific addon type and what the end user must configure when creating a new addon of that type.
11 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-addons-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

Unleash Client API
Unleash Admin UI API
Unleash API tokens API
Unleash Archive API
Unleash Auth API
Unleash Banners API
Unleash Change Requests API
Unleash Context API
Unleash Dependencies API
Unleash Environments API
Unleash Events API
Unleash Feature Types API