List discovered inbound HTTP endpoint functions.

GET

/api/workspace/admin/http-endpoints

curl --request GET \
  --url https://example.com/api/workspace/admin/http-endpoints

Authorizations

• None

Parameters

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Responses

200

OK

Media typeapplication/json

object

Data

Array<object>

nullable

Summary row for a discovered HTTP endpoint function.

object

Id

string

nullable

Key

string

nullable

DisplayName

string

nullable

RouteTemplate

string

nullable

AllowedMethods

integer format: int32

BusinessFunctionId

string

nullable

BusinessFunctionKey

string

nullable

BusinessFunctionName

string

nullable

IsEnabled

boolean

BodyMode

integer format: int32

Allowed values: 0 1 2 3

AuthMode

integer format: int32

Allowed values: 0 1 2 3

ActorMode

integer format: int32

Allowed values: 0 1

ActorUserId

string

nullable

HasActiveSharedSecret

boolean

HasActiveHmacSecret

boolean

RowVersion

string format: uuid

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Data": [
    {
      "BodyMode": 0,
      "AuthMode": 0,
      "ActorMode": 0
    }
  ],
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}