Skip to content
Sign in
Menu

Configure your API

Every field of an API's configuration, its validation rules, and what can be changed after launch.

On this page

Fields

FieldRulesEditable later
API name2 to 80 characters.Yes
Slug3 to 40 characters: lowercase letters, numbers and hyphens, not starting or ending with a hyphen. Unique.No
Description10 to 500 characters.Yes
Upstream URLA public https:// address, no username or password, no ? query or # fragment, at most 2,048 characters. A trailing / is removed.No
Upstream keyOptional. A header name from the list below, and a value of 1 to 4,096 characters.Replace or delete
Price per requestUSDC, up to 6 decimal places, at least the platform minimum. See Configure pricing.Yes
CategoryOne of the directory categories.Yes
Show in the public directoryOn by default.Yes

Upstream URL

The upstream URL is a base. Callers add paths and queries after the gateway URL, and NODRA adds them after your base:

TextIllustrative values
Upstream URL      https://api.example.com/v1
Gateway URL       https://gateway.example.com/v1/weather-forecasts

Caller requests   https://gateway.example.com/v1/weather-forecasts/forecast?city=Lisbon
NODRA requests    https://api.example.com/v1/forecast?city=Lisbon

Paths can't climb out of the base: path segments of . or .. are refused. NODRA refuses upstreams on private networks, loopback and link-local addresses, cloud metadata addresses, and names such as localhost or *.internal. It doesn't follow redirects, so make sure the base URL answers directly.

Upstream key

If your API needs a key, NODRA sends it as a request header on every forwarded call. Choose the header your API reads it from:

Supported header names
X-API-Key (default)
Authorization
Api-Key
ApiKey
X-Auth-Token
X-Access-Token
X-RapidAPI-Key
Ocp-Apim-Subscription-Key

For Authorization, enter the full header value your API expects, for example Bearer <token>. Keys in query strings or request bodies aren't supported.

Billing rule

The billing rule decides which answers are charged. APIs registered in the NODRA app use the default rule:

The backend also supports any 2xx answer, even an empty one, and a 2xx answer whose JSON has a true value at a given JSON pointer. These can't be chosen in the NODRA app yet. The rule is shown on your API's page in the dashboard and on its directory page.

Each payment is judged by the rule in force when its quote was issued, not the API's current settings.

Changing settings after launch

Name, description, category and listing changes apply straight away. A price change on a live or paused API is applied between payments; see Changing the price. The slug and upstream URL can't be changed: register a new API instead.