Skip to main content

APIs

APIs are logical organizations of endpoints. Companies typically separate APIs by the business functionality within them, the teams that own them, or the products they run.

Create an API

It's really fast to create an API with Sparky. Follow the get started tutorial to launch your first API.

Metadata

We offer some helpful metadata inputs for your API. These help organize the APIs within your organization and contribute to the auto-generated documentation.

Documentation

Sparky automatically generates documentation based on the details we know about your API. You can edit some pieces of the documentation by changing the API and endpoint metadata components, like names and descriptions.

Delete an API

caution

A deleted API cannot be easily recovered.

Deleting an API will create a "delete" deployment. This will deprovision all of the API resources that run your API. The deletion should finish within minutes, but the API may still be live in the meantime.