Provider Configuration Params

The ProviderConfigurationParameter resource

The argument of the provider configuration.

Key path

Description

type* (string)

Available values: provider-configuration-parameters

id (string)

attributes.description (string)

Variable description.

attributes.key* (string)

Parameter name.

attributes.sensitive (boolean)

Indicates whether the value is sensitive. When set to true then the parameter is not visible after being written.

attributes.value (string)

Parameter value. Not visible if sensitive: true is enabled

relationships.provider-configuration.data.type* (string)

Available values: provider-configurations

relationships.provider-configuration.data.id* (string)

links (object)

Delete a Provider configuration parameter

DELETE /api/iacp/v3/provider-configuration-parameters/{provider_configuration_parameter}

The endpoint deletes a Provider configuration parameter by ID.

Parameters
  • provider_configuration_parameter (string) – The ID of the Provider configuration parameter to delete.

Status Codes
  • 204 No Content – Deleted.

  • 404 Not Found – Provider configuration parameter not found or user unauthorized.

  • 4XX – Client error.

  • 5XX – Server error.

Get a Provider configuration parameter

GET /api/iacp/v3/provider-configuration-parameters/{provider_configuration_parameter}

Show details of a specific Proivider configuration parameter.

Parameters
  • provider_configuration_parameter (string) – The ID of the Provider configuration parameter.

Example Request:

GET /api/iacp/v3/provider-configuration-parameters/{provider_configuration_parameter} HTTP/1.1
Host: my.scalr.io
Prefer: profile=preview
Status Codes
  • 200 OK – Success.

  • 404 Not Found – Provider configuration parameter not found or user unauthorized to perform action.

  • 4XX – Client error.

  • 5XX – Server error.

Update a Provider configuration parameter

PATCH /api/iacp/v3/provider-configuration-parameters/{provider_configuration_parameter}

This endpoint allows updates to attributes of an existing Provider configuration parameters.

Parameters
  • provider_configuration_parameter (string) – The ID of the Provider configuration parameter to update.

Request body:

Key path

Description

data.type* (string)

Available values: provider-configuration-parameters

data.id (string)

data.attributes.description (string)

Variable description.

data.attributes.key* (string)

Parameter name.

data.attributes.sensitive (boolean)

Indicates whether the value is sensitive. When set to true then the parameter is not visible after being written.

data.attributes.value (string)

Parameter value. Not visible if sensitive: true is enabled

data.links (object)

Example Request:

PATCH /api/iacp/v3/provider-configuration-parameters/{provider_configuration_parameter} HTTP/1.1
Host: my.scalr.io
Content-Type: application/vnd.api+json
Prefer: profile=preview

{
    "data": {
        "attributes": {
            "description": "string",
            "key": "string",
            "sensitive": true,
            "value": "string"
        },
        "id": "string",
        "links": {},
        "type": "provider-configuration-parameters"
    }
}
Status Codes
  • 200 OK – Updated.

  • 403 Forbidden – User unauthorized to perform action.

  • 404 Not Found – Relationship resource not found, or user unauthorized to perform action.

  • 422 Unprocessable Entity – Malformed request body (missing attributes, wrong types, etc.).

  • 4XX – Client error.

  • 5XX – Server error.

List Provider configuration parameters for specific provider configurations

GET /api/iacp/v3/provider-configurations/{provider_configuration}/parameters

This endpoint returns a list of Provider configuration parameters for specific provider configuration.

Parameters
  • provider_configuration (string) – The ID of the Provider configuration.

Query Parameters
  • page[number] (string) – Page number

  • page[size] (string) – Page size

Example Request:

GET /api/iacp/v3/provider-configurations/{provider_configuration}/parameters HTTP/1.1
Host: my.scalr.io
Prefer: profile=preview
Status Codes
  • 200 OK – Success.

  • 403 Forbidden – User unauthorized to perform action.

  • 404 Not Found – Provider configuration not found.

  • 4XX – Client error.

  • 5XX – Server error.

Create a Provider configuration parameter

POST /api/iacp/v3/provider-configurations/{provider_configuration}/parameters

Create a new Provider configuration parameter.

Parameters
  • provider_configuration (string) – The ID of the Provider configuration.

Request body:

Key path

Description

data.type* (string)

Available values: provider-configuration-parameters

data.id (string)

data.attributes.description (string)

Variable description.

data.attributes.key* (string)

Parameter name.

data.attributes.sensitive (boolean)

Indicates whether the value is sensitive. When set to true then the parameter is not visible after being written.

data.attributes.value (string)

Parameter value. Not visible if sensitive: true is enabled

data.links (object)

Example Request:

POST /api/iacp/v3/provider-configurations/{provider_configuration}/parameters HTTP/1.1
Host: my.scalr.io
Content-Type: application/vnd.api+json
Prefer: profile=preview

{
    "data": {
        "attributes": {
            "description": "string",
            "key": "string",
            "sensitive": true,
            "value": "string"
        },
        "id": "string",
        "links": {},
        "type": "provider-configuration-parameters"
    }
}
Status Codes
  • 201 Created – Created.

  • 403 Forbidden – User unauthorized to perform action.

  • 404 Not Found – Provider configuration not found.

  • 422 Unprocessable Entity – Malformed request body (missing attributes, wrong types, etc.) or parameter cant be created for this provider.

  • 4XX – Client error.

  • 5XX – Server error.