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

Knock Branches API

Branches in Knock are a way to isolate changes to your Knock resources.

Knock Branches API is one of 35 APIs that Knock publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Branches. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 2 JSON Schemas.

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

Requests are made against a single base URL, https://api.knock.app.

4 operations 2 paths 2 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Server
https://api.knock.app
Authentication
HTTP Bearer
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — Knock API key as a Bearer token. Use a public key (pk...) for client-side requests or a secret key (sk...) for server-side.

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.

Branches 4

Branches in Knock are a way to isolate changes to your Knock resources.

GET
/v1/branches
List branches
listBranches 4 params → 200
DELETE
/v1/branches/{branch_slug}
Delete a branch
deleteBranch 2 params → 204
GET
/v1/branches/{branch_slug}
Get a branch
getBranch 2 params → 200
POST
/v1/branches/{branch_slug}
Create a branch
createBranch 2 params → 201

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Branch (5 properties), PageInfo (3 properties). Each schema is shown below with its type and property counts.

PageInfo
object
The information about a paginated result.
3 properties 1 required
Branch
object
A branch object.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-branches-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
Knock Accounts API
Knock API keys API
Knock Audiences API
Knock Broadcasts API
Knock Bulk operations API
Knock Channel data API
Knock Channel Groups API
Knock Channels API
Knock Commits API
Knock Email layouts API
Knock Environments API