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

Harbor Challenges API

Operations for managing challenges that members complete to earn points and rewards.

Harbor Challenges API is one of 6 APIs that Harbor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

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

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.harbor.gg/v1.

3 operations 2 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Server
https://api.harbor.gg/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Bearer token obtained via OAuth 2.0 client credentials flow. Contact Harbor to obtain API credentials.

Paths & Operations 3

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

Challenges 3

Operations for managing challenges that members complete to earn points and rewards.

GET
/communities/{communityId}/challenges
Harbor List challenges
listChallenges 2 params → 200401404
POST
/communities/{communityId}/challenges
Harbor Create a challenge
createChallenge 1 param body → 201400401
POST
/communities/{communityId}/challenges/{challengeId}/complete
Harbor Mark a challenge as completed by a member
completeChallenge 2 params body → 200400401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Challenge (11 properties), CreateChallengeRequest (7 properties), ChallengeCompletion (5 properties), CompleteChallengeRequest (3 properties). Each schema is shown below with its type and property counts.

ChallengeList
object
List of community challenges.
2 properties
Challenge
object
A challenge that community members can complete to earn points and rewards.
11 properties
CreateChallengeRequest
object
Request body for creating a new community challenge.
7 properties 3 required
CompleteChallengeRequest
object
Request body for recording a challenge completion.
3 properties 1 required
ChallengeCompletion
object
Result of a challenge completion recording.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harbor-challenges-api-openapi.yml Raw ↑

Other APIs Harbor publishes across the network.

Harbor Communities API
Harbor Leaderboards API
Harbor Members API
Harbor Redemptions API
Harbor Rewards API