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 Banners API

Create, update, flag, and delete [banners](https://docs.getunleash.io/concepts/banners).

Unleash Banners API is one of 36 APIs that Unleash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Banners. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 4 paths, and defines 3 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 4 paths 3 schemas 1 DELETE1 GET3 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 Banners 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 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Banners 6

Create, update, flag, and delete [banners](https://docs.getunleash.io/concepts/banners).

GET
/api/admin/banners
Get All Banners.
getBanners → 200401
POST
/api/admin/banners
Create a Banner.
createBanner body → 201400401403415
PUT
/api/admin/banners/{id}
Update a Banner.
updateBanner 1 param body → 200400401403404415
DELETE
/api/admin/banners/{id}
Delete a Banner.
deleteBanner 1 param → 200401403404
POST
/api/admin/banners/{id}/on
Enables a Banner.
enableBanner 1 param → 200401403404
POST
/api/admin/banners/{id}/off
Disables a Banner.
disableBanner 1 param → 200401403404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are bannerSchema (11 properties), createBannerSchema (9 properties), bannersSchema (1 property). Each schema is shown below with its type and property counts.

bannerSchema
object
An object describing a banner to be displayed to all users.
11 properties 3 required
createBannerSchema
object
Describes the properties required to create or update a banner.
9 properties 1 required
bannersSchema
object
A response model with a list of banners.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

unleash-banners-api-openapi.yml Raw ↑

Other APIs Unleash publishes across the network.

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