Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Pagegoat Me Controller API
description: 'Programmatic access to Pagegoat sites. Authenticate with a Bearer access token: exchange your API key at `POST {IdP}/api/keys/token`, then send the returned JWT as `Authorization: Bearer `.'
version: 0.1.0
servers:
- url: https://api.pagegoat.com
description: Generated server url
security:
- bearer-jwt: []
tags:
- name: me-controller
paths:
/health:
get:
tags:
- me-controller
summary: Liveness check
operationId: health
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Health'
/api/me:
get:
tags:
- me-controller
summary: Echo the caller's verified token claims
description: The quickest way to check that a key exchange produced a token this API actually accepts, and that the issuer matches.
operationId: me
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Me'
components:
schemas:
Health:
required:
- status
type: object
properties:
status:
type: string
example: ok
description: Liveness check.
Me:
required:
- audience
- issuer
- sub
type: object
properties:
sub:
type: string
description: 'Subject: who the token is for. This is the id everything else keys on.'
issuer:
type: string
description: Issuer. Must match what the API is configured to trust, or every request 401s with invalid_issuer.
audience:
type: array
description: Audience. `pagegoat-api` for a programmatic key.
items:
type: string
description: Audience. `pagegoat-api` for a programmatic key.
scope:
type:
- string
- 'null'
description: Space-separated scopes.
example: sites.read sites.write
clientId:
type:
- string
- 'null'
description: OAuth client the token was minted for.
description: The claims this API read out of your access token.
securitySchemes:
bearer-jwt:
type: http
scheme: bearer
bearerFormat: JWT