Sign in
hooks

List Hooks

This endpoint returns a list of hooks by various filters.

get/hooks

Request

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

Query parameters

filter[name]string

The Hook name filter.

filter[vcs-provider]string

The ID of the VCS provider

filter[hook]string

The ID(s) of the Hook(s).

filter[status]string

The status of the Hook. Possible values: 'pending', 'active', 'errored'.

page[number]string

Page number

page[size]string

Page size

querystring

The search string. Supports search by name/id of the Hook.

sortstring[]

The comma-separated list of attributes.

includestring[]

The comma-separated list of relationship paths.

accountsstring

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

hook-readmestring

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

hooksstring

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

usersstring

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

vcs-providersstring

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

vcs-revisionsstring

The comma-separated list of fields to return in response for VcsRevision 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 operation across all 1 revision of this API.