Type Alias EndpointConfigurationAPI

EndpointConfigurationAPI: {
    configuration: {
        apiEnvironment: string;
        apiEnvironmentRoute: string;
        apiId: string;
        organisationManagedSecretId?: number;
    };
    type: "ONEBLINK_API";
}

Examples

{
  "type": "ONEBLINK_API",
  "configuration": {
    "apiId": "oneblink-api-id",
    "apiEnvironment": "test",
    "apiEnvironmentRoute": "/my-route"
  }
}

Type declaration

  • configuration: {
        apiEnvironment: string;
        apiEnvironmentRoute: string;
        apiId: string;
        organisationManagedSecretId?: number;
    }

    The configuration of the OneBlink Hosted API.

    • apiEnvironment: string

      The environment of the specified OneBlink hosted API.

    • apiEnvironmentRoute: string

      The route of the specified API and Environment.

    • apiId: string

      The ID of the OneBlink hosted API that a request is made to.

    • OptionalorganisationManagedSecretId?: number

      The identifier for the organisation managed secret that is associated with the endpoint. Should represent the secret string used for verifying the authenticity of the request made from the OneBlink system.

  • type: "ONEBLINK_API"

    The type of endpoint.

Settings

Member Visibility

On This Page

Examples