List Credentials

client.VulnerabilityScanner.CredentialSets.Credentials.List(ctx, credentialSetID, params) (*V4PagePaginationArray[CredentialSetCredentialListResponse], error)

GET/accounts/{account_id}/vuln_scanner/credential_sets/{credential_set_id}/credentials

Returns all credentials within a credential set.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

credentialSetID string

formatuuid

params CredentialSetCredentialListParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Page param.Field[int64]Optional

Query param: Page number of paginated results.

minimum1

PerPage param.Field[int64]Optional

Query param: Number of results per page.

maximum50

minimum5

ReturnsExpand Collapse

type CredentialSetCredentialListResponse struct{…}

A credential attached to API requests during scanning. The credential value is write-only and never returned in responses.

ID string

Credential identifier.

formatuuid

CredentialSetID string

Parent credential set identifier.

formatuuid

Location CredentialSetCredentialListResponseLocation

Where the credential is attached in outgoing requests.

One of the following:

const CredentialSetCredentialListResponseLocationHeader CredentialSetCredentialListResponseLocation = "header"

const CredentialSetCredentialListResponseLocationCookie CredentialSetCredentialListResponseLocation = "cookie"

LocationName string

Name of the header or cookie where the credential is attached.

Name string

Human-readable name.

List Credentials

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/vulnerability_scanner"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.VulnerabilityScanner.CredentialSets.Credentials.List(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    vulnerability_scanner.CredentialSetCredentialListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "location": "header",
      "location_name": "Authorization",
      "name": "Admin API key"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "credential_set_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "location": "header",
      "location_name": "Authorization",
      "name": "Admin API key"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}