How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Consul Connect Intentions API

Service-to-service traffic authorization

Consul Connect Intentions API is one of 4 APIs that Consul Connect publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Intentions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 1 JSON Schema.

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

Requests are made against 2 base URLs: http://localhost:8500/v1, https://consul.example.com/v1.

6 operations 4 paths 2 schemas 1 DELETE4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
http://localhost:8500/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Consul Connect Intentions API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Consul-Token (ConsulToken). By default, every request must be authenticated.

Paths & Operations 6

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

Intentions 6

Service-to-service traffic authorization

GET
/connect/intentions
List all intentions
listIntentions 3 params → 200
GET
/connect/intentions/exact
Read intention by source and destination
readIntentionByExact 4 params → 200
PUT
/connect/intentions/exact
Create or replace intention by source and destination
upsertIntentionByExact 2 params body → 200
DELETE
/connect/intentions/exact
Delete intention by source and destination
deleteIntentionByExact 2 params → 200
GET
/connect/intentions/check
Check if a connection would be authorized
checkIntention 2 params → 200
GET
/connect/intentions/match
List intentions matching a source or destination
matchIntentions 2 params → 200

Schemas 2

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

Intention
object
11 properties
IntentionInput
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

consul-connect-intentions-api-openapi.yml Raw ↑

Other APIs Consul Connect publishes across the network.

Consul Connect Configuration Entries
Consul Connect Gateways
Consul Connect CA API
Where this information came from

This is an independent, third-party profile of Consul Connect Intentions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.