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

Ceramic Peers API

The Peers API from Ceramic — 1 operation(s) for peers.

Ceramic Peers API is one of 10 APIs that Ceramic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 0.58.0.

Requests are made against a single base URL, /ceramic.

3 operations 1 paths 4 schemas 1 GET1 OPTIONS1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.58.0
Base URL
http://localhost:5101/ceramic
License
Resource Areas
1

Paths & Operations 3

Across 1 path, the API surfaces 3 operations — 1 GET, 1 OPTIONS, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Peers 3
OPTIONS
/peers
cors
1 param → 200
GET
/peers
Get list of connected peers
→ 200500
POST
/peers
Connect to a peer
1 param → 204400500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Peer (2 properties), ErrorResponse (1 property), BadRequestResponse (1 property), Peers (1 property). Each schema is shown below with its type and property counts.

Peers
object
1 property 1 required
Peer
object
Information about a connected peer
2 properties 2 required
BadRequestResponse
object
Bad request (input error)
1 property 1 required
ErrorResponse
object
Error response
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ceramic-peers-api-openapi.yml Raw ↑

Other APIs Ceramic publishes across the network.

Ceramic Config API
Ceramic Debug API
Ceramic Events API
Ceramic Experimental API
Ceramic Feed API
Ceramic Interests API
Ceramic Liveness API
Ceramic Streams API
Ceramic Version API