Fetches a custom DLP profile.
/accounts/{account_identifier}/dlp/profiles/custom/{profile_id}
get
DLP Profiles
dlp-profiles-get-custom-profile
nullnull[
{
"in": "path",
"name": "profile_id",
"required": true,
"schema": {
"allOf": [
{
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
],
"description": "The ID for this profile",
"example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
}
},
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"allowed_match_count": {
"default": 0,
"description": "Related DLP policies will trigger when the match count exceeds the number set.",
"example": 5,
"maximum": 1000,
"minimum": 0,
"type": "number"
},
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The description of the profile.",
"example": "A standard CVV card number",
"type": "string"
},
"entries": {
"description": "The entries for this profile.",
"items": {
"description": "A custom entry that matches a profile",
"properties": {
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Whether the entry is enabled or not.",
"example": true,
"type": "boolean"
},
"id": {
"allOf": [
{
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
],
"description": "The ID for this entry",
"example": "719d1215-260f-41d0-8c32-eb320ad107f7"
},
"name": {
"description": "The name of the entry.",
"example": "Credit card (Visa)",
"type": "string"
},
"pattern": {
"description": "A pattern that matches an entry",
"properties": {
"regex": {
"description": "The regex pattern.",
"example": "^4[0-9]{6,14}$",
"type": "string"
},
"validation": {
"description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.",
"enum": [
"luhn"
],
"example": "luhn",
"type": "string"
}
},
"required": [
"regex"
],
"title": "Pattern",
"type": "object"
},
"profile_id": {
"description": "ID of the parent profile"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"title": "Custom entry",
"type": "object"
},
"type": "array"
},
"id": {
"allOf": [
{
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
],
"description": "The ID for this profile",
"example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
},
"name": {
"description": "The name of the profile.",
"example": "Generic CVV Card Number",
"type": "string"
},
"type": {
"description": "The type of the profile.",
"enum": [
"custom"
],
"example": "custom",
"type": "string"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"title": "Custom profile",
"type": "object"
}
]
}
}
}
]
}
}
},
"description": "Get custom profile response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"nullable": true,
"type": "object"
},
{
"nullable": true,
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"allowed_match_count": {
"default": 0,
"description": "Related DLP policies will trigger when the match count exceeds the number set.",
"example": 5,
"maximum": 1000,
"minimum": 0,
"type": "number"
},
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The description of the profile.",
"example": "A standard CVV card number",
"type": "string"
},
"entries": {
"description": "The entries for this profile.",
"items": {
"description": "A custom entry that matches a profile",
"properties": {
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Whether the entry is enabled or not.",
"example": true,
"type": "boolean"
},
"id": {
"allOf": [
{
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
],
"description": "The ID for this entry",
"example": "719d1215-260f-41d0-8c32-eb320ad107f7"
},
"name": {
"description": "The name of the entry.",
"example": "Credit card (Visa)",
"type": "string"
},
"pattern": {
"description": "A pattern that matches an entry",
"properties": {
"regex": {
"description": "The regex pattern.",
"example": "^4[0-9]{6,14}$",
"type": "string"
},
"validation": {
"description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.",
"enum": [
"luhn"
],
"example": "luhn",
"type": "string"
}
},
"required": [
"regex"
],
"title": "Pattern",
"type": "object"
},
"profile_id": {
"description": "ID of the parent profile"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"title": "Custom entry",
"type": "object"
},
"type": "array"
},
"id": {
"allOf": [
{
"description": "UUID",
"example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
"maxLength": 36,
"readOnly": true,
"type": "string"
}
],
"description": "The ID for this profile",
"example": "384e129d-25bd-403c-8019-bc19eb7a8a5f"
},
"name": {
"description": "The name of the profile.",
"example": "Generic CVV Card Number",
"type": "string"
},
"type": {
"description": "The type of the profile.",
"enum": [
"custom"
],
"example": "custom",
"type": "string"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"title": "Custom profile",
"type": "object"
}
]
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Get custom profile response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]