KEkeycardai
Resources

List resources

Changed on

Returns a paginated list of resources in the specified zone. Use cursor pagination via after/before, and expand[]=total_count to include the matching row count. Filter by exact identifier via filter[identifier]. Filter by trait via filter[traits] (repeated params are OR'd) or filter[traits][all] (contains-all). The scalar identifier query parameter is a backward-compatible alias for filter[identifier]: exact match on a single value, folded into the same exact-match identifier filter.

get/zones/{zoneId}/resources

Request

  • Base URL
    https://docs.keycard.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://docs.keycard.ai/zones/{zoneId}/resources
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
string

Filter by exact resource slug

OR
string[]
string

Filter by exact resource identifier

OR
string[]
string

Restrict results to resources with this publicId. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
string

Search by name (substring match)

OR
string[]
string

Search by identifier (substring match)

OR
string[]
string

Search across name and identifier (substring match)

OR
string[]
sortstring

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, updated_at, name, identifier

filter[owner_type]'platform' | 'customer'

Filter by owner type: platform (Keycard-managed) or customer (org-created).

identifierstring

Backward-compatible alias for filter[identifier]: exact match on a single resource identifier.

credentialProviderIdstring

Filter resources by credential provider ID

slugstring
string
OR
string[]

Filter by trait. Repeated params are OR'd; each value is a single literal trait (a comma is a literal character). Use filter[traits][all] for contains-all.

string

Resources that are not a dependency of this application. Repeatable (none of), max 100.

OR
string[]

Response

Default Response

Changes

  • 0dee67e0a73aRevision changes
    • warning

      changed the pattern of the query request parameter sort from ^-?(created_at|name|identifier)(,\s*-?(created_at|name|identifier))*$ to ^-?(created_at|updated_at|name|identifier)(,\s*-?(created_at|updated_at|name|identifier))*$

    • info

      added the new optional query request parameter filter[dependency_of_application_id][ne]

  • 0cfaff865771Revision changes
    • warning

      removed the optional property ////// from the response with the status

    • info

      added the new optional query request parameter filter[id]

    • info

      added the new optional query request parameter filter[slug]

    • info

      added the new optional query request parameter query[]

    • info

      added the new optional query request parameter query[identifier]

    • info

      added the new optional query request parameter query[name]

    • info

      added the new optional query request parameter sort