Endpoint Commands

Manage endpoints using the CLI

Endpoint Commands

Manage API endpoints exposed by your integrations and services.

Usage

weikio endpoints [command] [options]

Subcommands

ls

List all current endpoints.

Usage:

weikio endpoints ls

Example:

weikio endpoints ls

operations

List operations available on an endpoint.

Usage:

weikio endpoints operations <EndpointId>

Arguments:

NameRequiredDescription
EndpointIdYesID of the endpoint

Example:

weikio endpoints operations my-endpoint

browse

Browse an endpoint using Swagger UI.

Usage:

weikio endpoints browse <EndpointId>

Arguments:

NameRequiredDescription
EndpointIdYesID of the endpoint

Example:

weikio endpoints browse my-endpoint

schema

View the schema of an endpoint.

Usage:

weikio endpoints schema <EndpointId>

Arguments:

NameRequiredDescription
EndpointIdYesID of the endpoint

Example:

weikio endpoints schema my-endpoint

connect

Connect to an endpoint.

Usage:

weikio endpoints connect <EndpointId>

Arguments:

NameRequiredDescription
EndpointIdYesID of the endpoint to connect to

Example:

weikio endpoints connect my-endpoint

add

Add a new endpoint.

Usage:

weikio endpoints add <Name> <Route> <API>

Arguments:

NameRequiredDescription
NameYesName of the endpoint
RouteYesRoute path for the endpoint
APIYesAPI to expose through this endpoint

Example:

weikio endpoints add my-endpoint /api/data MyAPI