Create platform preferences

Create new platform preferences. The platform preferences name must be unique within the platform and can contain only alphanumeric characters, dashes and underscores.

application/json

Request Body required

preferences object[]
Array [
name string
value string
]

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

preference object[]
Array [
id string
name string
value string
resourceId string
resourceType string
createdAt date-time
The time when the preference was created.
updatedAt date-time
The time when the preference was updated.
]

{
  "preference": [
    {
      "id": "string",
      "name": "string",
      "value": "string",
      "resourceId": "string",
      "resourceType": "string",
      "createdAt": "2023-06-07T05:39:56.961Z",
      "updatedAt": "2023-06-07T05:39:56.961Z"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

POST /v1beta1/preferences

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

Body required

{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

curl / cURL

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

python / requests

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

go / native

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

nodejs / axios

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

csharp / RestSharp

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

php / cURL

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

java / OkHttp

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'

powershell / RestMethod

curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "preferences": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}'