Jump to

• Request
• Response

Get available locales

get

https://{your_site_interface}/opa-hub/api/12.2.35/deployments/{deployment-name}/activeVersion/locales

This operation will get a deployment version's available locales.

Request

Path Parameters

• deployment-name(required): string
  The name of the deployment.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : locales

Type: object

Show Source

• available(required): array available
  An array of all the available locales for this policy model.
• default-locale(required): string
  The default locale for this policy model.

{
    "type":"object",
    "properties":{
        "default-locale":{
            "type":"string",
            "description":"The default locale for this policy model."
        },
        "available":{
            "type":"array",
            "description":"An array of all the available locales for this policy model.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false,
    "required":[
        "available",
        "default-locale"
    ]
}

Nested Schema : available

Type: array

An array of all the available locales for this policy model.

Show Source

• Array of: string

{
    "type":"array",
    "description":"An array of all the available locales for this policy model.",
    "items":{
        "type":"string"
    }
}

Back to Top