v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB

modules

List 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.

get/modules

Query parameters

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[source-type]string

Filter modules by source type

filter[environment]string

Filter modules by environment

filter[module]string

The ID(s) of the Module.

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

querystring

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

filter[module-namespace]string

Filter modules by namespace

filter[namespace][environments]string

Filter modules by namespace environments

includestring[]

The comma-separated list of relationship paths.

sortstring[]

The comma-separated list of attributes.

docker-integrationsstring

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

environmentsstring

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

module-namespacesstring

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

module-versionsstring

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

modulesstring

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

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.