List Modules

get

https://{Domain}/api/iacp/v3/modules

This endpoint lists modules by various filters.

To list modules accessible from a certain environment, filter[environment] has to be specified. Modules from the account which this environment belongs as well as globally published modules will be listed as well.

To list modules accessible from a certain account, filter[account] has to be specified. Modules published globally will be listed as well.

To list modules accessible globally, both filter[account]=null and filter[environment]=null have to be specified.

If no filters were specified, all modules which the user has read access to will be listed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page[number]

string

Page number

page[size]

string

Page size

filter[name]

string

Filter modules by name

filter[provider]

string

Filter modules by provider

filter[source]

string

Filter modules by source

filter[status]

string

Filter modules by status

filter[environment]

string

Filter modules by environment

filter[account]

string

Filter modules by account

filter[module-versions][status]

string

Filter modules by module-version status

filter[module-versions][is-root-module]

string

Filter modules by module-version is-root-module

filter[vcs-provider]

string

The ID of the VCS provider

query

string

Query string, search by id, name, provider, and submodules recursively

filter[module-namespace]

string

Filter modules by namespace

filter[namespace][environments]

string

Filter modules by namespace environments

include

array of strings

The comma-separated list of relationship paths.

include

sort

array of strings

The comma-separated list of attributes.

sort

fields

object

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.

Responses

404

Modules not found, or user unauthorized to perform action.

4XX

Client error.

5XX

Server error.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200Success.