Platform - proxies | Elastic Cloud Enterprise Reference [2.2]

» » »

« Platform - configuration - Store Stack - Instance Types - CRUD »

Platform - proxies

Get proxies

Retrieves an overview of all proxies.

Request

GET /api/v1/platform/infrastructure/proxies

Responses

200

(ProxyOverview) An overview of all proxies.

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies \
-u $CLOUD_USER:$CLOUD_KEY

Create filtered group of proxies

Create the settings for a filtered group of proxies.

Request

POST /api/v1/platform/infrastructure/proxies/filtered-groups

Request body

(ProxiesFilteredGroup) (required) Data for the filtered group of proxies to create

Responses

200

(ProxiesFilteredGroup) Returns the created or updated filtered group of proxies

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

400

(BasicFailedReply) * The filtered group of proxies has empty id. (code: proxies.proxies_filtered_group_empty_id) * A filtered group of proxies with the same identifier already exists. (code: proxies.proxies_filtered_group_already_exists)

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPOST {{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "filters" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "id" : "string"
}
'

Delete filtered group of proxies

Deletes a filtered group of proxies by ID.

Request

DELETE /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Path parameters

Name	Type	Required	Description
`proxies_filtered_group_id`	`string`	Y	"The identifier for the filtered group of proxies

Query parameters

Name	Type	Required	Description
`version`	`integer`	N	Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header.

Responses

200: (EmptyResponse) The filtered group of proxies was successfully deleted
404: (BasicFailedReply) Unable to find the {proxies_filtered_group_id} specified filtered group of proxies. Edit your request, then try again. (code: proxies.proxies_filtered_group_not_found)
409: (BasicFailedReply) There is a version conflict. (code: proxies.proxies_filtered_group_version_conflict)
449: (BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XDELETE {{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} \
-u $CLOUD_USER:$CLOUD_KEY

Get filtered group of proxies

Get data for a filtered group of proxies.

Request

GET /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Path parameters

Name	Type	Required	Description
`proxies_filtered_group_id`	`string`	Y	"The identifier for the filtered group of proxies

Responses

200

(ProxiesFilteredGroup) Data for the filtered group of proxies identified by {proxies_filtered_group_id}

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

404

(BasicFailedReply) Unable to find the {proxies_filtered_group_id} specified filtered group of proxies. Edit your request, then try again. (code: proxies.proxies_filtered_group_not_found)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} \
-u $CLOUD_USER:$CLOUD_KEY

Update filtered group of proxies

Update the settings for a filtered group of proxies.

Request

PUT /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}

Path parameters

Name	Type	Required	Description
`proxies_filtered_group_id`	`string`	Y	"The identifier for the filtered group of proxies

Query parameters

Name	Type	Required	Description
`version`	`integer`	N	Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header.

Request body

(ProxiesFilteredGroup) (required) Data for the filtered group of proxies to update

Responses

200

(ProxiesFilteredGroup) Returns the created or updated filtered group of proxies

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

400

(BasicFailedReply) The provided identifier doesn't match the identifier in the object. (code: proxies.proxies_filtered_group_id_conflict)

409

(BasicFailedReply) There is a version conflict. (code: proxies.proxies_filtered_group_version_conflict)

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id} \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "filters" : [
      {
         "key" : "string",
         "value" : "string"
      }
   ],
   "id" : "string"
}
'

Get health for a filtered group of proxies

Get the health status of a filtered group of proxies.

Request

GET /api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health

Path parameters

Name	Type	Required	Description
`proxies_filtered_group_id`	`string`	Y	"The identifier for the filtered group of proxies

Query parameters

Name	Type	Required	Description
`expect_status`	`string`	N	The expected status

Responses

200: (ProxiesFilteredGroupHealth) Returns health information on a filtered group of proxies
417: (ProxiesHealth) The health status is worse than the expected one.
449: (BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/filtered-groups/{proxies_filtered_group_id}/health \
-u $CLOUD_USER:$CLOUD_KEY

Get proxy health

Get the health status of all proxies.

Request

GET /api/v1/platform/infrastructure/proxies/health

Query parameters

Name	Type	Required	Description
`expect_status`	`string`	N	The expected status

Responses

200: (ProxiesHealth) Returns health information on all the proxies
417: (ProxiesHealth) The health status is worse than the expected one.
449: (BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/health \
-u $CLOUD_USER:$CLOUD_KEY

Get proxies settings

Retrieves the settings for all proxies.

Request

GET /api/v1/platform/infrastructure/proxies/settings

Responses

200

(ProxiesSettings) Settings for all proxies.

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY

Update proxy settings

Applies the settings as a patch. Only the fields that are referenced in the update are changed.

Request

PATCH /api/v1/platform/infrastructure/proxies/settings

Query parameters

Name	Type	Required	Description
`version`	`integer`	N	If specified, checks for conflicts against the version of the repository configuration (returned in 'x-cloud-resource-version' of the GET request)

Request body

(string) (required) A JSON to merge with the existing settings

Responses

200

(ProxiesSettings) Returns the updated settings

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

409

(BasicFailedReply) There is a version conflict. (code: proxies.version_conflict)

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPATCH {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY

Set proxy settings

Overwrites the proxy settings. All unspecified fields are deleted.

Request

PUT /api/v1/platform/infrastructure/proxies/settings

Query parameters

Name	Type	Required	Description
`version`	`integer`	N	If specified, checks for conflicts against the version of the settings (returned in 'x-cloud-resource-version' of the GET request)

Request body

(ProxiesSettings) (required) The proxy settings to apply

Responses

200

(ProxiesSettings) Returns the updated settings

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

409

(BasicFailedReply) There is a version conflict. (code: proxies.version_conflict)

449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XPUT {{hostname}}/api/v1/platform/infrastructure/proxies/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "expected_proxies_count" : 0,
   "http_settings" : {
      "cookie_secret" : "string",
      "dashboards_base_url" : "string",
      "disconnected_cutoff" : 0,
      "minimum_proxy_services" : 0,
      "sso_settings" : {
         "cookie_name" : "string",
         "default_redirect_path" : "string",
         "dont_log_requests" : true,
         "maintenance_bypass_cookie_name" : "string",
         "max_age" : 0,
         "sso_secret" : "string"
      },
      "user_cookie_key" : "string"
   },
   "signature_secret" : "string",
   "signature_valid_for_millis" : 0
}
'

Get proxy

Retrieves a single proxy by ID.

Request

GET /api/v1/platform/infrastructure/proxies/{proxy_id}

Path parameters

Name	Type	Required	Description
`proxy_id`	`string`	Y	The identifier for the proxy

Responses

200: (ProxyInfo) The information for the proxy specified by {proxy_id}.
404: (BasicFailedReply) Unable to find the {proxy_id} specified proxy. Edit your request, then try again. (code: proxies.proxy_not_found)

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

curl -XGET {{hostname}}/api/v1/platform/infrastructure/proxies/{proxy_id} \
-u $CLOUD_USER:$CLOUD_KEY

« Platform - configuration - Store Stack - Instance Types - CRUD »

Platform - proxies

Get proxies

Request

Responses

Request example

Create filtered group of proxies

Request

Request body

Responses

Request example

Delete filtered group of proxies

Request

Path parameters

Query parameters

Responses

Request example

Get filtered group of proxies

Request

Path parameters

Responses

Request example

Update filtered group of proxies

Request

Path parameters

Query parameters

Request body

Responses

Request example

Get health for a filtered group of proxies

Request

Path parameters

Query parameters

Responses

Request example

Get proxy health

Request

Query parameters

Responses

Request example

Get proxies settings

Request

Responses

Request example

Update proxy settings

Request

Query parameters

Request body

Responses

Request example

Set proxy settings

Request

Query parameters

Request body

Responses

Request example

Get proxy

Request

Path parameters

Responses

Request example

Getting Started Videos

Be in the know with the latest and greatest from Elastic.