vcs-providers

List VCS Providers

This endpoint returns a list of VCS providers by various filters.

To list VCS providers accessible from a specific environment - filter[environment], or when from a specific account - filter[account] has to be specified.

For self-hosted Scalr there's also an option to list all VCS providers created globally

  • both filter[account]=null and filter[environment]=null has to be specified.

If no environment or account filters were specified, all VCS providers to which a current user has read access will be returned.

get/vcs-providers

Query parameters

querystring

Full text search based on a VCS provider's name

page[number]string

Page number

page[size]string

Page size

filter[vcs-provider]string

The ID of the VCS provider. Multiple values are allowed through COMMA ,

filter[vcs-type]string

Filter by VCS type

filter[name]string

Filter by VCS name

filter[environment]string

The environment filter

filter[account]string

The account filter

filter[agent-pool]string

The agent pool filter

sortstring[]

The comma-separated list of attributes.

includestring[]

The comma-separated list of relationship paths.

agent-poolsstring

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

vcs-providersstring

The comma-separated list of fields to return in response for VcsProvider 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.

Changes

No recorded changes to this endpoint across all 1 revision of this API.