Get Shared Template - ProjectDiscovery Documentation

{
  "message": "<string>",
  "result": {
    "uri": "<string>",
    "id": "<string>",
    "name": "<string>",
    "author": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "severity": "<string>",
    "type": "<string>",
    "dir": "<string>",
    "ref": "<string>",
    "vendor": "<string>",
    "product": "<string>",
    "classification": {
      "cve-id": [
        "<string>"
      ],
      "cwe-id": [
        "<string>"
      ],
      "cvss-metrics": "<string>",
      "cvss-score": 123,
      "epss-score": 123,
      "epss-percentile": 123,
      "cpe": "<string>"
    },
    "metadata": {},
    "digest": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "release_tag": "<string>",
    "is_early": true,
    "raw": "<string>",
    "template_id": "<string>",
    "description": "<string>",
    "filename": "<string>",
    "impact": "<string>",
    "ai_meta": {
      "model_used": "<string>",
      "is_prompt_by_human": true,
      "is_template_by_human": true,
      "prompt": "<string>"
    },
    "references": [
      "<string>"
    ],
    "template_type": "public",
    "is_draft": true,
    "is_github": true,
    "is_new": true,
    "is_pdteam": true,
    "remediation": "<string>",
    "ttl": "<string>",
    "share_type": "<string>",
    "users_email": [
      "<string>"
    ],
    "organizations": [
      "<string>"
    ]
  }
}

GET

template

{template_id}

{
  "message": "<string>",
  "result": {
    "uri": "<string>",
    "id": "<string>",
    "name": "<string>",
    "author": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "severity": "<string>",
    "type": "<string>",
    "dir": "<string>",
    "ref": "<string>",
    "vendor": "<string>",
    "product": "<string>",
    "classification": {
      "cve-id": [
        "<string>"
      ],
      "cwe-id": [
        "<string>"
      ],
      "cvss-metrics": "<string>",
      "cvss-score": 123,
      "epss-score": 123,
      "epss-percentile": 123,
      "cpe": "<string>"
    },
    "metadata": {},
    "digest": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "release_tag": "<string>",
    "is_early": true,
    "raw": "<string>",
    "template_id": "<string>",
    "description": "<string>",
    "filename": "<string>",
    "impact": "<string>",
    "ai_meta": {
      "model_used": "<string>",
      "is_prompt_by_human": true,
      "is_template_by_human": true,
      "prompt": "<string>"
    },
    "references": [
      "<string>"
    ],
    "template_type": "public",
    "is_draft": true,
    "is_github": true,
    "is_new": true,
    "is_pdteam": true,
    "remediation": "<string>",
    "ttl": "<string>",
    "share_type": "<string>",
    "users_email": [
      "<string>"
    ],
    "organizations": [
      "<string>"
    ]
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

template_id

string

required

unique template ID

Query Parameters

fields

string

get selected fields e.g. name,template_id,severity, etc

Response

Example response

message

string

required

result

object

required

Template Document or object

Show child attributes

result.uri

string

The URI of the template (could be a path or a ksuid)

result.id

string

The ID of the template

result.name

string

The name of the template

result.author

string[]

The authors of the template

result.tags

string[]

The tags of the template

result.severity

string

The severity of the template

result.type

string

The type of the template

result.dir

string

result.ref

string

result.vendor

string

The vendor of the template

result.product

string

The product of the template

result.classification

object

Classification of template including additional metadata like cve-id, cwe-id etc

Show child attributes

result.classification.cve-id

string[]

CVE IDs for the template

result.classification.cwe-id

string[]

CWE IDs for the template

result.classification.cvss-metrics

string

CVSS Metrics for the template

result.classification.cvss-score

number<float>

CVSS Score for the template

result.classification.epss-score

number<float>

EPSS Score for the template

result.classification.epss-percentile

number<float>

EPSS Percentile for the template

result.classification.cpe

string

CPE for the template

result.metadata

object

result.digest

string

The digest of the template

result.created_at

string<date-time>

The time when template was created

result.updated_at

string<date-time>

The time when template was updated

result.release_tag

string

The release tag of the template (contains tag when the file was first released)

result.is_early

boolean

True if template is in early access

result.raw

string

The raw unparsed template

result.template_id

string

result.description

string

result.filename

string

result.impact

string

result.ai_meta

object

Show child attributes

result.ai_meta.model_used

string

The AI model used to generate the template

result.ai_meta.is_prompt_by_human

boolean

Whether the prompt was written by a human

result.ai_meta.is_template_by_human

boolean

Whether the template was written by a human

result.ai_meta.prompt

string

The prompt used to generate the template

result.references

string[]

result.template_type

enum<string>

Available options:

public,

user,

shared

result.is_draft

boolean

result.is_github

boolean

result.is_new

boolean

result.is_pdteam

boolean

Is the template from pdteam

result.remediation

string

result.ttl

string

Time to live duration (1d ,1m etc)

Type of share (unlisted, users, organization)

result.users_email

string[]

List of email addresses or user IDs to share with (required if share_type is set to 'users')

result.organizations

string[]

Share Template Get Scan List

⌘I

API Reference

Authorizations

Path Parameters

Query Parameters

Response