Update admin-owned HTTP endpoint function settings.

PUT

/api/workspace/admin/http-endpoints/{endpointId}/settings

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/admin/http-endpoints/example/settings"),
    Content = new StringContent("{ \"IsEnabled\": true, \"AuthMode\": 0, \"ActorMode\": 0, \"ActorUserId\": \"example\", \"MaxBodyBytes\": 1, \"MaxFormFieldCount\": 1, \"MaxFormKeyLength\": 1, \"MaxFormValueLength\": 1, \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/admin/http-endpoints/example/settings';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"IsEnabled":true,"AuthMode":0,"ActorMode":0,"ActorUserId":"example","MaxBodyBytes":1,"MaxFormFieldCount":1,"MaxFormKeyLength":1,"MaxFormValueLength":1,"RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/admin/http-endpoints/example/settings \
  --header 'Content-Type: application/json' \
  --data '{ "IsEnabled": true, "AuthMode": 0, "ActorMode": 0, "ActorUserId": "example", "MaxBodyBytes": 1, "MaxFormFieldCount": 1, "MaxFormKeyLength": 1, "MaxFormValueLength": 1, "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

None

Parameters

Path Parameters

endpointId

required

string

Query Parameters

access_token

string

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

Request Body

Update admin-owned HTTP endpoint function settings.

object

IsEnabled

boolean

AuthMode

integer format: int32

Allowed values: 0 1 2 3

ActorMode

integer format: int32

Allowed values: 0 1

ActorUserId

string

nullable

MaxBodyBytes

integer format: int32

nullable

MaxFormFieldCount

integer format: int32

nullable

MaxFormKeyLength

integer format: int32

nullable

MaxFormValueLength

integer format: int32

nullable

RowVersion

string format: uuid

nullable

Responses

200

application/json

object

Data

Detailed HTTP endpoint function configuration.

object

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

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
    }
  ]
}

400

Bad Request

application/json

object

Data

Detailed HTTP endpoint function configuration.

object

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

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

Forbidden

application/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"
}

404

Not Found

application/json

object

Data

Detailed HTTP endpoint function configuration.

object

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

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
    }
  ]
}

409

Conflict

application/json

object

Data

Detailed HTTP endpoint function configuration.

object

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

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
    }
  ]
}

Update admin-owned HTTP endpoint function settings.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated