namespace

Gets or lists a namespace resource.

Overview

Name	namespace
Type	Resource
Id	gitlab.groups.namespace

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the namespace.
name	string	Name of the namespace.
full_name	string	Full name of the namespace.
actual_repository_size_limit	number	Size limit for repositories in the namespace in bytes. This limit only applies to namespaces under Project limit enforcement.
actual_size_limit	number	The actual storage size limit (in bytes) based on the enforcement type of either repository or namespace. This limit is agnostic of enforcement type.
additional_purchased_storage_size	number	Additional storage purchased for the root namespace in bytes.
avatar_url	string	URL to avatar image file of the namespace.
contains_locked_projects	boolean	Includes at least one project where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
cross_project_pipeline_available	boolean	Indicates if the cross_project_pipeline feature is available for the namespace.
description	string	Description of the namespace.
full_path	string	Full path of the namespace.
lfs_enabled	boolean	Indicates if Large File Storage (LFS) is enabled for namespace.
path	string	Path of the namespace.
repository_size_excess_project_count	integer	Number of projects in the root namespace where the repository size exceeds the limit. This only applies to namespaces under Project limit enforcement.
request_access_enabled	boolean	Indicates if users can request access to namespace.
shared_runners_setting	string	Shared runners availability for the namespace and its descendants. (DISABLED_AND_UNOVERRIDABLE, DISABLED_AND_OVERRIDABLE, ENABLED)
storage_size_limit	number	The storage limit (in bytes) included with the root namespace plan. This limit only applies to namespaces under namespace limit enforcement.
total_repository_size	number	Total repository size of all projects in the root namespace in bytes.
total_repository_size_excess	number	Total excess repository size of all projects in the root namespace in bytes. This only applies to namespaces under Project limit enforcement.
visibility	string	Visibility of the namespace.
web_url	string	URL of the namespace.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, host		Find a namespace. Generated from the GitLab GraphQL schema field Query.namespace (Namespace).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the namespace. For example, gitlab-org/gitlab-foss.
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)

SELECT examples

get

Find a namespace. Generated from the GitLab GraphQL schema field Query.namespace (Namespace).

SELECT
id,
name,
full_name,
actual_repository_size_limit,
actual_size_limit,
additional_purchased_storage_size,
avatar_url,
contains_locked_projects,
cross_project_pipeline_available,
description,
full_path,
lfs_enabled,
path,
repository_size_excess_project_count,
request_access_enabled,
shared_runners_setting,
storage_size_limit,
total_repository_size,
total_repository_size_excess,
visibility,
web_url
FROM gitlab.groups.namespace
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;