API keys

Create an API key

Every field is optional. scopes: ["read"] makes a read-only key. Caps are USD strings; platforms limits which platforms the key may order for; allowedIps limits where it can be used from (addresses or CIDR ranges, up to 20). The full key is in this answer only — store it now. Up to 20 active keys.

post/api/v1/keys

Request

  • Base URL: https://spoofy.social
  • URL: https://spoofy.social/api/v1/keys
  • Auth: API key in cookie better-auth.session_token

Request body

namestring
scopesstring[]
dailyCapstring nullable
perOrderCapstring nullable
platformsstring[]
allowedIpsstring[]

Optional: the key works only from these addresses or CIDR ranges.

mode'live' | 'test'

test: a key that starts spoofy_test_ and answers every spend as a dry run.

Response

Created. key is shown once.

keystring

Changes

No recorded changes to this operation across all 1 revision of this API.