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. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: FSC Core Announce API
version: 1.0.0
description: Manager REST API
servers:
- url: https://{managerUrl}:8443/v1
variables:
managerUrl:
default: localhost
description: URL of the Manager
tags:
- name: Announce
paths:
/announce:
put:
operationId: announce
summary: Used to announce a Peer to the Manager
description: When the Manager address of a Peer changes, the Peer can announce the new address using this endpoint
parameters:
- $ref: '#/components/parameters/headerFscManagerAddress'
responses:
200:
description: announcement was a success
tags:
- Announce
components:
parameters:
headerFscManagerAddress:
in: header
name: fsc-manager-address
description: The URL of the Manager. The scheme must be https and the URL must contain the port.
schema:
type: string
example: https://manager.com:8443
required: true