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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Keboola

Keboola Maintainers API

Manage maintainer records, their members and invitations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Keboola Maintainers API is one of 79 APIs that Keboola publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 16 operations across 9 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://connection.keboola.com/v2/storage.

16 operations 9 paths 9 schemas 4 DELETE6 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://connection.keboola.com/v2/storage
Authentication
API Key
Contact
devel@keboola.com
License
MIT
Resource Areas
1

Authentication & Security 1

Keboola Maintainers API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 16

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

Maintainers 16

Manage maintainer records, their members and invitations.

POST
/manage/maintainers/{id}/join-maintainer
Join maintainer
post_/manage/maintainers/{id}/join-maintainer::JoinMaintainerAction 1 param → 204400404
GET
/manage/maintainers/{id}/users
List maintainer users
get_/manage/maintainers/{id}/users::MaintainerListAdministratorsAction 1 param → 200401403404
POST
/manage/maintainers/{id}/users
Add a User to maintainer
post_/manage/maintainers/{id}/users::MaintainerAddAdministratorAction 1 param body → 200400401403404
GET
/manage/maintainers
List maintainers
get_/manage/maintainers::MaintainerListAction → 200401
POST
/manage/maintainers
Create a maintainer
post_/manage/maintainers::MaintainerCreateAction body → 200400401403
GET
/manage/maintainers/{id}/invitations
List maintainers invitations
get_/manage/maintainers/{id}/invitations::MaintainerListInvitationsAction 1 param → 200401403404
POST
/manage/maintainers/{id}/invitations
Invite a user to a maintainer
post_/manage/maintainers/{id}/invitations::MaintainerCreateInvitationAction 1 param body → 201400401403404422
GET
/manage/maintainers/{id}
Retrieve a maintainer
get_/manage/maintainers/{id}::MaintainerDetailAction 1 param → 200401403404
DELETE
/manage/maintainers/{id}
Delete a maintainer
delete_/manage/maintainers/{id}::MaintainerDeleteAction 1 param → 204400401403404
PATCH
/manage/maintainers/{id}
Update a maintainer
patch_/manage/maintainers/{id}::MaintainerUpdateAction 1 param body → 200400401403404
GET
/manage/maintainers/{id}/invitations/{invitationId}
Maintainer invitation detail
get_/manage/maintainers/{id}/invitations/{invitationId}::MaintainerGetInvitationAction 2 params → 200401403404
DELETE
/manage/maintainers/{id}/invitations/{invitationId}
Cancel maintainer invitation
delete_/manage/maintainers/{id}/invitations/{invitationId}::MaintainerDeleteInvitationAction 2 params → 204401403404
DELETE
/manage/maintainers/{id}/metadata/{metadataId}
Remove maintainer metadata
delete_/manage/maintainers/{id}/metadata/{metadataId}::MaintainerDeleteMetadataAction 2 params → 204401403404
GET
/manage/maintainers/{id}/metadata
List maintainer metadata
get_/manage/maintainers/{id}/metadata::MaintainerListMetadataAction 1 param → 200401403404
POST
/manage/maintainers/{id}/metadata
Set maintainer metadata
post_/manage/maintainers/{id}/metadata::MaintainerSetMetadataAction 1 param body → 201400401403404
DELETE
/manage/maintainers/{id}/users/{adminId}
Remove a user from maintainer
delete_/manage/maintainers/{id}/users/{adminId}::MaintainerRemoveAdministratorAction 2 params → 204400401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are MaintainerResponse (12 properties), CreateMaintainerRequest (9 properties), UpdateMaintainerRequest (9 properties), UserResponse (7 properties). Each schema is shown below with its type and property counts.

MaintainerDetailResponse
object
CreateMaintainerInvitationRequest
object
1 property 1 required
UserResponse
object
7 properties 7 required
CreateMaintainerRequest
object
9 properties 1 required
SetMaintainerMetadataRequest
object
2 properties 2 required
AddMaintainerAdministratorRequest
object
2 properties
MaintainerResponse
object
12 properties 4 required
MaintainerInvitationDetailResponse
object
4 properties 3 required
UpdateMaintainerRequest
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-maintainers-api-openapi.yml Raw ↑

Other APIs Keboola publishes across the network.

Keboola Actions API
AE Profile APIs.io
Keboola Admin Apps API
AE Profile APIs.io
Keboola Admin Stacks API
AE Profile APIs.io
Keboola Admin Users API
AE Profile APIs.io
Keboola Admin Vendors API
AE Profile APIs.io
Keboola App API
AE Profile APIs.io
Keboola Auth API
AE Profile APIs.io
Keboola Authorize API
AE Profile APIs.io
Keboola Branch metadata API
AE Profile APIs.io
Keboola Buckets API
AE Profile APIs.io
Keboola Columns API
AE Profile APIs.io
Keboola Component Configuration Metadata API
AE Profile APIs.io
#Maintainers
← Back to K APIs
API Details
ID
keboola:keboola-maintainers-api
Base URL
https://connection.keboola.com/v2/storage
Docs
https://api.keboola.com/?service=storage
Provider
Keboola
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network