Skip to main content

Gets context field

GET <your-unleash-url>/api/admin/context/:contextField

Authorization

name: Authorizationtype: apiKeyin: header

Returns specific context field identified by the name in the path

Request

Path Parameters

  • contextField string required
Responses

contextFieldSchema

Schema
  • name string required

    The name of the context field

  • description string nullable

    The description of the context field.

  • stickiness boolean

    Does this context field support being used for stickiness calculations

  • sortOrder integer

    Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.

  • createdAt date-time nullable

    When this context field was created

  • usedInFeatures integer nullable

    Number of projects where this context field is used in

  • usedInProjects integer nullable

    Number of projects where this context field is used in

  • legalValues object[]

    Allowed values for this context field schema. Can be used to narrow down accepted input

  • Array [
  • value string required

    The valid value

  • description string

    Describes this specific legal value

  • ]

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
<your-unleash-url>
apiKey
contextField — path required
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/context/:contextField' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'