Represents an api endpoint that is being provided.

Hierarchy

  • IApiEndpoint

Implemented by

Properties

_availableMethods?: string[]

The methods that are available for this endpoint. This property is provided by the Runtime and should not be set manually.

Its values are used on the Apps-Engine to validate the request method.

authRequired?: boolean

Whether this endpoint requires an authenticated user to access it.

The authentication will be done by the host server using its own authentication system.

If no authentication is provided, the request will be automatically rejected with a 401 status code.

examples?: {
    [key: string]: IApiExample;
}

Type declaration

path: string

The last part of the api URL. Example: https://{your-server-address}/api/apps/public/{your-app-id}/{path} or https://{your-server-address}/api/apps/private/{your-app-id}/{private-hash}/{path}

Methods

Generated using TypeDoc