List Registry Credentials

List Registry Credentials
List registry credentials

Retrieve all registry credentials the user has access to. All users have read access to foundation-scoped registry credentials. All Org Users have read access to respective organization-scoped registry credentials. Users must have a Space specific role for read access to space-scoped registry credentials.

Request
URI
GET
https://api.example.local/v3/registry_credentials
COPY
Query Parameters
integer
page
Optional

Page to display; valid values are integers >= 1

page example
1
integer
per_page
Optional

Number of results per page, valid values are 1 through 5000

per_page example
50
string
order_by
Optional

Value to sort by. Defaults to ascending; prepend with - to sort descending.

order_by example
created_at
string
created_ats
Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

created_ats example
2021-01-01T00:00:00Z
string
updated_ats
Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

updated_ats example
2021-01-01T00:00:00Z
string
label_selector
Optional

A query string containing a list of label selector requirements

label_selector example
environment=production
string of array
guids
Optional

Comma-delimited list of registry credential guids to filter by

string of array
app_guids
Optional

Comma-delimited list of app guids to filter by

string of array
space_guids
Optional

Comma-delimited list of space guids to filter by

string of array
organization_guids
Optional

Comma-delimited list of organization guids to filter by

string of array
scopes
Optional

Comma-delimited list of scopes to filter by

string of array
locations
Optional

Comma-delimited list of locations to filter by

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RegistryCredentialList of type(s) application/json
This response body class contains all of the following: Pagination , InlineRegistryCredentialList1 
{
    "total_results": 0,
    "total_pages": 0,
    "first": {
        "href": "string",
        "method": "string"
    },
    "last": {
        "href": "string",
        "method": "string"
    },
    "next": {
        "href": "string",
        "method": "string"
    },
    "previous": {
        "href": "string",
        "method": "string"
    },
    "resources": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "location": "string",
            "username": "string",
            "scope": "string",
            "relationships": {
                "organization": {
                    "data": {
                        "guid": "string"
                    }
                },
                "space": {
                    "data": {
                        "guid": "string"
                    }
                },
                "app": {
                    "data": {
                        "guid": "string"
                    }
                }
            },
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "app": {
                    "href": "string",
                    "method": "string"
                },
                "organization": {
                    "href": "string",
                    "method": "string"
                },
                "space": {
                    "href": "string",
                    "method": "string"
                }
            }
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


401

Unauthorized

Returns Unauthorized of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


500

Internal Server Error

Returns 500 of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


502

Bad Gateway

Returns BadGateway of type(s) application/json 
{
    "code": 0,
    "detail": "string",
    "title": "string"
}
integer
code
Optional

A numeric code for this error

string
detail
Optional

Detailed description of the error

string
title
Optional

Name of the error


503

Service Unavailable

Returns ServiceUnavailable of type(s) application/json 
{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}
array of object
errors
Optional

errors


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v3/registry_credentials
On This Page
Registry Credentials Operations
GET
List Registry Credentials
POST
Create Registry Credential
GET
Get Registry Credential
PATCH
Update Registry Credential
DELETE
Delete Registry Credential