Skip to content
MoltaroMoltaroMoltaro Docs

Get HTTP endpoint function settings and secret metadata.

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

Authorizations

Section titled “Authorizations”
  • None

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
endpointId
required
string

Query Parameters

Section titled “Query Parameters”
access_token
string

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
Data

Detailed HTTP endpoint function configuration.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
RouteTemplate
string
nullable
AllowedMethods
integer format: int32
BusinessFunctionId
string
nullable
BusinessFunctionKey
string
nullable
BusinessFunctionName
string
nullable
BusinessFunctionVersionId
string
nullable
VersionResolutionMode
integer format: int32
Allowed values: 0 1
IsEnabled
boolean
DescriptorBodyMode
integer format: int32
Allowed values: 0 1 2 3
DescriptorAuthMode
integer format: int32
Allowed values: 0 1 2 3
DescriptorActorMode
integer format: int32
Allowed values: 0 1
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
SharedSecretHeaderName
string
nullable
HmacSignatureHeaderName
string
nullable
HmacTimestampHeaderName
string
nullable
HmacTimestampToleranceSeconds
integer format: int32
MaxBodyBytes
integer format: int32
MaxFormFieldCount
integer format: int32
MaxFormKeyLength
integer format: int32
MaxFormValueLength
integer format: int32
Secrets
Array<object>
nullable

Secret metadata for an HTTP endpoint function. The secret value is never included here.

object
Id
string
nullable
Purpose
integer format: int32
Allowed values: 0 1
VersionNumber
integer format: int32
Name
string
nullable
IsActive
boolean
CreatedAt
string format: date-time
RetiredAt
string format: date-time
nullable
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": {
    "VersionResolutionMode": 0,
    "DescriptorBodyMode": 0,
    "DescriptorAuthMode": 0,
    "DescriptorActorMode": 0,
    "BodyMode": 0,
    "AuthMode": 0,
    "ActorMode": 0,
    "Secrets": [
      {
        "Purpose": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Section titled “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
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
Data

Detailed HTTP endpoint function configuration.

object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
RouteTemplate
string
nullable
AllowedMethods
integer format: int32
BusinessFunctionId
string
nullable
BusinessFunctionKey
string
nullable
BusinessFunctionName
string
nullable
BusinessFunctionVersionId
string
nullable
VersionResolutionMode
integer format: int32
Allowed values: 0 1
IsEnabled
boolean
DescriptorBodyMode
integer format: int32
Allowed values: 0 1 2 3
DescriptorAuthMode
integer format: int32
Allowed values: 0 1 2 3
DescriptorActorMode
integer format: int32
Allowed values: 0 1
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
SharedSecretHeaderName
string
nullable
HmacSignatureHeaderName
string
nullable
HmacTimestampHeaderName
string
nullable
HmacTimestampToleranceSeconds
integer format: int32
MaxBodyBytes
integer format: int32
MaxFormFieldCount
integer format: int32
MaxFormKeyLength
integer format: int32
MaxFormValueLength
integer format: int32
Secrets
Array<object>
nullable

Secret metadata for an HTTP endpoint function. The secret value is never included here.

object
Id
string
nullable
Purpose
integer format: int32
Allowed values: 0 1
VersionNumber
integer format: int32
Name
string
nullable
IsActive
boolean
CreatedAt
string format: date-time
RetiredAt
string format: date-time
nullable
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": {
    "VersionResolutionMode": 0,
    "DescriptorBodyMode": 0,
    "DescriptorAuthMode": 0,
    "DescriptorActorMode": 0,
    "BodyMode": 0,
    "AuthMode": 0,
    "ActorMode": 0,
    "Secrets": [
      {
        "Purpose": 0
      }
    ]
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}