Create or rotate a managed HTTP endpoint secret. Plaintext is returned only once.

POST

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/admin/http-endpoints/example/secrets"),
    Content = new StringContent("{ \"Purpose\": 0, \"Name\": \"example\", \"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/secrets';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"Purpose":0,"Name":"example","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 POST \
  --url https://example.com/api/workspace/admin/http-endpoints/example/secrets \
  --header 'Content-Type: application/json' \
  --data '{ "Purpose": 0, "Name": "example", "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

Create or rotate a managed HTTP endpoint secret.

object

Purpose

integer format: int32

Allowed values: 0 1

Name

string

nullable

RowVersion

string format: uuid

nullable

Responses

200

application/json

object

Data

Created or rotated HTTP endpoint secret. Plaintext is returned only once.

object

Secret

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

PlaintextSecret

string

nullable

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": {
    "Secret": {
      "Purpose": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

application/json

object

Data

Created or rotated HTTP endpoint secret. Plaintext is returned only once.

object

Secret

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

PlaintextSecret

string

nullable

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": {
    "Secret": {
      "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

Created or rotated HTTP endpoint secret. Plaintext is returned only once.

object

Secret

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

PlaintextSecret

string

nullable

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": {
    "Secret": {
      "Purpose": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

409

Conflict

application/json

object

Data

Created or rotated HTTP endpoint secret. Plaintext is returned only once.

object

Secret

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

PlaintextSecret

string

nullable

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": {
    "Secret": {
      "Purpose": 0
    }
  },
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

Create or rotate a managed HTTP endpoint secret. Plaintext is returned only once.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Body

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Example^generated