Create Credential

client.VulnerabilityScanner.CredentialSets.Credentials.New(ctx, credentialSetID, params) (*CredentialSetCredentialNewResponse, error)

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

Creates a new credential 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 CredentialSetCredentialNewParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Location param.Field[CredentialSetCredentialNewParamsLocation]

Body param: Where the credential is attached in outgoing requests.

const CredentialSetCredentialNewParamsLocationHeader CredentialSetCredentialNewParamsLocation = "header"

const CredentialSetCredentialNewParamsLocationCookie CredentialSetCredentialNewParamsLocation = "cookie"

LocationName param.Field[string]

Body param: Name of the header or cookie where the credential is attached.

Name param.Field[string]

Body param: Human-readable name.

Value param.Field[string]

Body param: The credential value (e.g. API key, session token). Write-only. Never returned in responses.

ReturnsExpand Collapse

type CredentialSetCredentialNewResponse 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 CredentialSetCredentialNewResponseLocation

Where the credential is attached in outgoing requests.

One of the following:

const CredentialSetCredentialNewResponseLocationHeader CredentialSetCredentialNewResponseLocation = "header"

const CredentialSetCredentialNewResponseLocationCookie CredentialSetCredentialNewResponseLocation = "cookie"

LocationName string

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

Name string

Human-readable name.

Create Credential

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"),
  )
  credential, err := client.VulnerabilityScanner.CredentialSets.Credentials.New(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    vulnerability_scanner.CredentialSetCredentialNewParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Location: cloudflare.F(vulnerability_scanner.CredentialSetCredentialNewParamsLocationHeader),
      LocationName: cloudflare.F("Authorization"),
      Name: cloudflare.F("Admin API key"),
      Value: cloudflare.F("Bearer EXAMPLE_TOKEN"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", credential.ID)
}

{
  "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": {}
}

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": {}
}