GET/v2/projects/{projectId}/namespace-by-name/{name}

Get a namespace by name

Retrieves a namespace in a project by its name. Supply name and projectId to identify the namespace and the project it belongs to.

2 parameters
namestringrequired
The name of the namespace to retrieve.
projectIdintegerrequired
The integer identifier of the project containing the namespace.

5 status codes
200Returns the namespace's integer `id` and `name`.
idintegerrequired
The id of namespace
namestringrequired
400Returned when the request is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to access the namespace.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the namespace or project is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned for an invalid request; a 401 is returned when authentication is missing or invalid; a 403 is returned when the authenticated user lacks permission; and a 404 is returned when the namespace or project is not found. The name path parameter must identify the namespace in the project specified by the projectId path parameter.