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

APIs.io Engineering Platform Tags API

The Tags API from APIs.io Engineering Platform — 3 operation(s) for tags.

This API exposes 4 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

4 operations 3 paths 16 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Tags API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

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

Tags 4
GET
/tags/{resource_arn}
Gets the Tags collection for a given resource.
GetTags 10 params → 200480481482483
PUT
/tags/{resource_arn}
Adds or updates a tag on a given resource.
TagResource 8 params body → 204480481482483484485
DELETE
/tags/{resource_arn}#tagKeys
Removes a tag from a given resource.
UntagResource 9 params → 204480481482483484485
GET
/tags/{slug}/entities
APIs.io Engineering Platform Get elements by tag
getTaggedEntities 5 params → 200400401403404500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are tag404Error (5 properties), tag500Error (5 properties), tag401Error (4 properties), tag403Error (4 properties). Each schema is shown below with its type and property counts.

TooManyRequestsException
ascDescDefaultDesc
string
NotFoundException
tag403Error
object
4 properties
tag500Error
object
5 properties
UnauthorizedException
tag404Error
object
5 properties
ConflictException
BadRequestException
LimitExceededException
tag401Error
object
4 properties
String
string
MapOfStringToString
object
getTaggedEntities
object
2 properties
tagElement400Error
object
3 properties
Tags
object
The collection of tags. Each tag element is associated with a given resource.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-tags-api-openapi.yml Raw ↑