Skip to main content
The jojapi CLI works with your APIs and your API keys from a terminal, a CI job or an AI agent. It uses the Management API with a scoped token. Every write that cannot be undone shows what will change and asks before it runs.
Inside a project made by jojapi pull, commands use the API named in jojapi.json unless you pass a slug.

Token scopes

Give the token the scopes your commands use; the templates in Settings › Tokens cover the common jobs. A command whose scope is missing stops and names the scope it needs, and jojapi whoami shows what the token may do. Tokens created before these scopes (with listings:read, code:write and the like) keep working exactly as before; Settings › Tokens offers to upgrade them.

Code and deployments

Every save is a preview first. This covers code, variables, bindings and the mode. --prod on deploy, resources, vars or mode puts only that change into production at once, for example to rotate a leaked key. jojapi deployments keep|public|archive <id> changes one deployment, and jojapi changes discard returns the working copy to what production runs. To deploy from GitHub, see Deploy from GitHub.

Bindings, variables and settings

The CLI never takes a secret as an argument, because the value would stay in the shell history. Type it at a prompt that does not echo it, or pipe it in. resources remove and vars unset ask before they run. Removed storage and its data are deleted once no active deployment uses it, so a rollback still finds it. See Shared resources for grants between APIs.

Endpoints as code

jojapi export writes the API as an OpenAPI 3.2 document, hidden endpoints included. Importing that document again changes nothing, so you can keep it in a repository and edit it there:
jojapi import changes nothing until you add --apply. First it prints every change, field by field:
  • new endpoints, with their parameters, body and responses;
  • for changed endpoints, each value before and after, with JSON paths inside schemas and examples;
  • endpoints missing from the document;
  • the API’s details.
It ends with a digest of exactly that preview. --apply --expect <digest> applies that preview and nothing else. If the document, the options or the API changed since the preview, it refuses. Without a terminal, which covers CI and agents, --apply requires --expect. In a terminal, --apply without --expect shows the preview and asks first. What an import changes, and what it leaves alone: The CLI reads OpenAPI (JSON or YAML) and Postman Collections, from a file or a URL. jojapi import without a source re-imports from the URL of the last import. RapidAPI and Apify imports run in the Studio. For quick edits there are smaller commands. jojapi endpoints show|add|update|hide|disable|delete|duplicate|move changes one endpoint, and jojapi endpoints example stores a response example. jojapi endpoints deprecate|undeprecate marks an endpoint deprecated with its replacement and removal date, and jojapi endpoints callers lists who still calls it; see Deprecating an Endpoint. jojapi groups, jojapi faqs and jojapi objects manage the rest of the listing. jojapi update --marketplace public submits the API for review, and if it is refused it names the checks that failed. jojapi page shows the marketplace page as consumers see it.

Pricing

New plans are private until you make them public. Price, currency, period and included quotas never change; for a new price, create a new plan and transfer subscribers to it in the Studio. Each pricing command shows what will change before it asks. That includes plans that would refuse an endpoint (402), the subscribers plans add-object will email, and the fact that a grant adds again if you run it twice. See Billable objects and Agent payments.

Traffic and logs

Request logs never show credentials or cookies, not even in --json; a jk_ key is shortened to its last four characters. Request bodies are never logged. --details adds the consumer’s IP address, the headers and the response body.

API keys

The CLI keeps key values off the screen. jojapi keys shows them masked, and jojapi keys create --to-env-file .env writes the new key to a dotenv file as JOJAPI_KEY=… (--env-name picks another name) without printing it; a new file is created readable by you only. Only --reveal prints a value. Both need a token with keys:read, and create checks that before it makes a key. Without --project, a key goes to your first project.
The option is --to-env-file, not --env-file: Node.js reads --env-file itself from anywhere on the command line, and either stops when the file does not exist or loads it into the environment.
For agents: create the key with --to-env-file and read it from your code, so the value never enters your transcript or logs. Use --reveal only when a person needs to see a key.

Scripts and agents

  • Read commands, deploy, import, resources, vars and mode take --json and print one line of JSON. Progress goes to stderr.
  • A command that asks first won’t run without a terminal; it prints what would change instead. --yes answers the question. import --apply takes --expect <digest> instead of --yes.
  • Exit code 0 means done, or nothing to do. Any other code means a refusal, a failure or a usage error, with the reason on stderr.
  • JOJAPI_TOKEN and JOJAPI_BASE override the stored configuration, so CI needs only JOJAPI_TOKEN.
  • API key values never reach the output unless you pass --reveal; keys create --to-env-file writes a new key to a file instead.