SCscalr
var-sets

List variable sets

Returns a list of variable sets.

get/var-sets

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/var-sets
  • Auth
    HTTP bearer

Query parameters

filter[name]string

Filter by variable set name.

filter[environment]string

Filter by environment — returns sets accessible to that environment.

filter[workspace]string

The ID of the workspace to list variable sets for.

filter[var-set]string

Filter by variable set ID(s).

page[number]string

Page number.

page[size]string

Page size.

sortstring[]

The comma-separated list of attributes.

querystring

Query string

includestring[]

The comma-separated list of relationship paths.

accountsstring

The comma-separated list of fields to return in response for Account resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

teamsstring

The comma-separated list of fields to return in response for Team resource.

var-setsstring

The comma-separated list of fields to return in response for VariableSet resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.

includedobject[]
linksobject
metaobject

Changes

No recorded changes to this operation across all 2 revisions of this API.