Get DLP Entry

client.ZeroTrust.DLP.Entries.Get(ctx, entryID, query) (*DLPEntryGetResponse, error)

GET/accounts/{account_id}/dlp/entries/{entry_id}

Fetches a DLP entry by ID.

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

Accepted Permissions (at least one required)

Zero Trust ReadZero Trust Write

ParametersExpand Collapse

entryID string

formatuuid

query DLPEntryGetParams

AccountID param.Field[string]

ReturnsExpand Collapse

type DLPEntryGetResponse interface{…}

One of the following:

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

DeprecatedEnabled bool

Name string

Pattern Pattern

Regex string

DeprecatedValidation PatternValidationOptional

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

Description stringOptional

DeprecatedProfileID stringOptional

formatuuid

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

DeprecatedEnabled bool

Name string

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

Description stringOptional

The optional description of the custom prompt topic entry.

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

Confidence DLPEntryGetResponseObjectConfidence

AIContextAvailable bool

Indicates whether this entry has AI remote service validation.

Available bool

Indicates whether this entry has any form of validation that is not an AI remote service.

Enabled bool

Name string

Type DLPEntryGetResponseObjectType

DeprecatedProfileID stringOptional

formatuuid

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

Variant DLPEntryGetResponseObjectVariantOptional

A Predefined AI prompt classification topic entry.

One of the following:

type DLPEntryGetResponseObjectVariantObject struct{…}

A Predefined AI prompt classification topic entry.

TopicType DLPEntryGetResponseObjectVariantObjectTopicType

One of the following:

const DLPEntryGetResponseObjectVariantObjectTopicTypeIntent DLPEntryGetResponseObjectVariantObjectTopicType = "Intent"

const DLPEntryGetResponseObjectVariantObjectTopicTypeContent DLPEntryGetResponseObjectVariantObjectTopicType = "Content"

Type DLPEntryGetResponseObjectVariantObjectType

Description stringOptional

A customer-facing explanation of what this predefined AI prompt topic represents.

type DLPEntryGetResponseObjectVariantObject struct{…}

A general predefined entry.

Type DLPEntryGetResponseObjectVariantObjectType

Description stringOptional

A customer-facing explanation of what this predefined entry represents.

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

Enabled bool

Name string

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

ProfileID stringOptional

formatuuid

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CaseSensitive bool

Only applies to custom word lists. Determines if the words should be matched in a case-sensitive manner Cannot be set to false if secret is true

CreatedAt Time

formatdate-time

Enabled bool

Name string

Secret bool

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

Description stringOptional

The optional description of the exact data entry.

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

Enabled bool

Name string

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

Description stringOptional

The optional description of the document fingerprint entry.

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

type DLPEntryGetResponseObject struct{…}

ID string

formatuuid

CreatedAt Time

formatdate-time

Enabled bool

Name string

Type DLPEntryGetResponseObjectType

UpdatedAt Time

formatdate-time

WordList unknown

ProfileID stringOptional

formatuuid

Profiles []DLPEntryGetResponseObjectProfileOptional

ID string

formatuuid

Name string

UploadStatus DLPEntryGetResponseObjectUploadStatusOptional

One of the following:

const DLPEntryGetResponseObjectUploadStatusEmpty DLPEntryGetResponseObjectUploadStatus = "empty"

const DLPEntryGetResponseObjectUploadStatusUploading DLPEntryGetResponseObjectUploadStatus = "uploading"

const DLPEntryGetResponseObjectUploadStatusPending DLPEntryGetResponseObjectUploadStatus = "pending"

const DLPEntryGetResponseObjectUploadStatusProcessing DLPEntryGetResponseObjectUploadStatus = "processing"

const DLPEntryGetResponseObjectUploadStatusFailed DLPEntryGetResponseObjectUploadStatus = "failed"

const DLPEntryGetResponseObjectUploadStatusComplete DLPEntryGetResponseObjectUploadStatus = "complete"

Get DLP Entry

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  entry, err := client.ZeroTrust.DLP.Entries.Get(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    zero_trust.DLPEntryGetParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", entry)
}

{
  "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",
    "created_at": "2019-12-27T18:11:19.117Z",
    "enabled": true,
    "name": "name",
    "pattern": {
      "regex": "regex",
      "validation": "luhn"
    },
    "type": "custom",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "profiles": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name"
      }
    ],
    "upload_status": "empty"
  }
}

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",
    "created_at": "2019-12-27T18:11:19.117Z",
    "enabled": true,
    "name": "name",
    "pattern": {
      "regex": "regex",
      "validation": "luhn"
    },
    "type": "custom",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "profile_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "profiles": [
      {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "name": "name"
      }
    ],
    "upload_status": "empty"
  }
}