--- title: "ListScanCreditUsages" method: GET path: "/v1/namespaces/{tenant_meta.namespace}/scan-credit-usages" tags: ["ScanCreditUsageService"] --- # ListScanCreditUsages `GET /v1/namespaces/{tenant_meta.namespace}/scan-credit-usages` ## Request - Base URL: `https://api.endorlabs.com` - URL: `https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/scan-credit-usages` - Auth: none declared Lists ScanCreditUsage records visible in the namespace. ## Path parameters - `tenant_meta.namespace` string, required ## Query parameters - `list_parameters.filter` string - `list_parameters.page_token` integer - `list_parameters.page_size` integer - `list_parameters.action` string - `list_parameters.mask` string - `list_parameters.traverse` boolean - `list_parameters.sort.path` string - `list_parameters.sort.order` 'SORT_ENTRY_ORDER_UNSPECIFIED' | 'SORT_ENTRY_ORDER_ASC' | 'SORT_ENTRY_ORDER_DESC' - `list_parameters.count` boolean - `list_parameters.group.aggregation_paths` string - `list_parameters.group.show_aggregation_uuids` boolean - `list_parameters.group.unique_count_paths` string - `list_parameters.group.unique_value_paths` string - `list_parameters.ci_run_uuid` string - `list_parameters.page_id` string - `list_parameters.group_by_time.aggregation_paths` string - `list_parameters.group_by_time.show_aggregation_uuids` boolean - `list_parameters.group_by_time.interval` 'GROUP_BY_TIME_INTERVAL_UNSPECIFIED' | 'GROUP_BY_TIME_INTERVAL_YEAR' | 'GROUP_BY_TIME_INTERVAL_QUARTER' | 'GROUP_BY_TIME_INTERVAL_MONTH' | 'GROUP_BY_TIME_INTERVAL_WEEK' | 'GROUP_BY_TIME_INTERVAL_DAY' | 'GROUP_BY_TIME_INTERVAL_HOUR' | 'GROUP_BY_TIME_INTERVAL_MINUTE' | 'GROUP_BY_TIME_INTERVAL_SECOND' - `list_parameters.group_by_time.group_size` integer - `list_parameters.group_by_time.start_time` string, date-time - `list_parameters.group_by_time.end_time` string, date-time - `list_parameters.group_by_time.mode` string - `list_parameters.group_by_time.aggregation_value_field` string - `list_parameters.group_by_time.aggregation_operator` string - `list_parameters.disable_pagination` boolean ## Response `200` A successful response. - V1ListScanCreditUsagesResponse: Response returned for requests to list ScanCreditUsage records. - `count_response` V1CountResponse: Response to a list count request. - `count` integer: Number of objects matching the given list parameters. - `group_response` V1GroupResponse: Response to a list group request. - `groups` object: Map indexed by values of the fields specified in aggregation_paths, for example, {"[{"key":"meta.kind","value":"Project"}]": { "aggregation_count": { "count": 1649 } } }. - `list` V1ListScanCreditUsagesResponseList: List of scan credit usage records. - `objects` V1ScanCreditUsage[]: List of scan credit usage records. - `meta` V1Meta, required: Common fields for all Endor Labs resources. - `annotations` object: Annotations can be used to attach metadata to a resource message. Annotation values can be small or large, structured or unstructured, and may include characters not permitted by labels. The keys may contain alphanumerics, underscores (_), dots (.) and dashes (-). The values of an annotation must be 16384 bytes or smaller. - `create_time` string, date-time: Time the resource was created. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `created_by` string: Name and authentication source of the user who created the object, for example, ewok@endor.ai@google@api-key. - `description` string: Resource description. Must be less than 1024 bytes. - `index_data` V1IndexData: IndexData is used to index the resource for search. It's an internal object. - `data` string[] - `search_score` number, float: search_score is the score of the resource for search. Internal use only. - `tenant` string - `will_be_deleted_at` string, date-time: Time that the resource will be deleted. - `kind` string: Resource kind, for example, HelloResponse. Auto-generated using the protobuf message proto.MessageName().Name(). - `name` string, required: Resource name. Must be 63 characters or less. - `parent_kind` string: Parent object resource kind, for example, Project. - `parent_uuid` string: Parent object UUID. - `references` object: Map of objects referenced in a query API. - `tags` string[]: List of tags attached to the resource. Tags can be used to select objects and to find collections of objects that satisfy certain conditions. A tag must be 255 characters or less. - `update_time` string, date-time: Time the resource was last updated. Note: Updated on all create/patch/delete operations. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `updated_by` string: Name and authentication source of the last user who updated the object, for example, vulnerabilityingestor@endor.ai@x509. - `upsert_time` string, date-time: Time the resource was last upserted. Note: create_time is only set the first time the resource is created. upsert_time is set every time the resource is upseted. Format: 2017-01-15T01:30:15.01Z RFC 3339: https://www.ietf.org/rfc/rfc3339.txt. - `version` string: Message version. - `spec` V1ScanCreditUsageSpec, required - `credits_period_start` string, date-time, required: Anchor timestamp of the current contract term. Snapshotted from EndorLicense.spec.credits_period_start at aggregation time so historic rows remain interpretable after renewal. - `cumulative_breakdown` ScanCreditUsageScanCreditBreakdown, required: ScanCreditBreakdown holds the six (context x component) credit counters that make up either a window or cumulative total. Components collapse to SCA vs code (SAST + AI_SAST + SECRETS) per the New License Model. - `code_ci_run_credits` string, int64: Code scan credits (SAST + AI_SAST + SECRETS collapsed) from PR scans. - `code_main_overflow_credits` string, int64: Code scan credits from default-branch scans on projects beyond the 5x-seats repo cap. Always zero when onboarded_project_count <= 5 * seats. - `code_ref_credits` string, int64: Code scan credits from non-default ref scans. - `sca_ci_run_credits` string, int64: SCA scan credits from PR scans (Context.type = CONTEXT_TYPE_CI_RUN). - `sca_main_overflow_credits` string, int64: SCA scan credits from default-branch scans (Context.type = CONTEXT_TYPE_MAIN) on projects beyond the 5x-seats repo cap. Always zero when onboarded_project_count <= 5 * seats. - `sca_ref_credits` string, int64: SCA scan credits from non-default ref scans (Context.type = CONTEXT_TYPE_REF). - `cumulative_scan_credits` string, int64, required: Cumulative credits consumed since credits_period_start through window_end. Sum of all six cumulative_breakdown counters. Used to render remaining credits and overage in the UI without rescanning all snapshots. - `onboarded_project_count` integer: Number of non-deleted projects onboarded under the tenant observed at aggregation time. Used to decide whether the 5x-seats default-branch cap was exceeded. - `overflow_project_count` integer: Number of projects beyond the 5x-seats cap whose default-branch scans contributed to *_main_overflow_credits counters. Zero when onboarded_project_count <= 5 * seats. - `scan_credit_limit` string, int64: Scan credit limit in effect at aggregation time. Snapshotted from EndorLicense.spec.scan_credit_limit. Overage = max(0, cumulative_scan_credits - credit_limit). - `window_breakdown` ScanCreditUsageScanCreditBreakdown, required: ScanCreditBreakdown holds the six (context x component) credit counters that make up either a window or cumulative total. Components collapse to SCA vs code (SAST + AI_SAST + SECRETS) per the New License Model. - `code_ci_run_credits` string, int64: Code scan credits (SAST + AI_SAST + SECRETS collapsed) from PR scans. - `code_main_overflow_credits` string, int64: Code scan credits from default-branch scans on projects beyond the 5x-seats repo cap. Always zero when onboarded_project_count <= 5 * seats. - `code_ref_credits` string, int64: Code scan credits from non-default ref scans. - `sca_ci_run_credits` string, int64: SCA scan credits from PR scans (Context.type = CONTEXT_TYPE_CI_RUN). - `sca_main_overflow_credits` string, int64: SCA scan credits from default-branch scans (Context.type = CONTEXT_TYPE_MAIN) on projects beyond the 5x-seats repo cap. Always zero when onboarded_project_count <= 5 * seats. - `sca_ref_credits` string, int64: SCA scan credits from non-default ref scans (Context.type = CONTEXT_TYPE_REF). - `window_end` string, date-time, required: End of the aggregation window this snapshot covers (exclusive). All ScanResults with create_time in [window_start, window_end) contributed to window_* fields. - `window_scan_credits` string, int64, required: Total credits consumed during [window_start, window_end). Sum of all six window_breakdown counters. - `window_start` string, date-time, required: Start of the aggregation window this snapshot covers (inclusive). Typically equals the previous run's window_end, or term_start for the first run of a term. - `tenant_meta` V1TenantMeta, required: Tenant related data for the tenant containing the resource. - `namespace` string, required: Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app". - `uuid` string: The UUID of the scan credit usage record. - `response` V1ListResponse: Response to a list request. - `next_page_id` string: The UUID of last message retrieved. - `next_page_token` integer: Pagination token that can be used to retrieve the next page of results. ## Other responses - `default`: An unexpected error response. ## Changes - **2026-11-03** `4acd9fe15140`: 1 info - endpoint added [Operation history](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/changes/v1/namespaces/:tenant_meta.namespace/scan-credit-usages/get.md) --- [API](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference.md) - [All operations](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/endorlabs/apis/endor-labs-rest-api-reference/revisions/4acd9fe15140?raw)