---
updatedAt: 2026-07-02T14:39:48.000Z
---

# Add entry points

This operation enables you to add one or more entry points for this site. Entry points are the base HTTP requests the WhiteHat scanner uses to test the site.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-explorer-enabled": false,
  "info": {
    "title": "Site API (Legacy)",
    "license": {
      "name": "(c) Copyright 2021 WhiteHat Security"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com"
    }
  ],
  "paths": {
    "/api/site/{site_id}/entry_points": {
      "post": {
        "tags": [
          "Site API v1.0"
        ],
        "summary": "Add entry points",
        "description": "This operation enables you to add one or more entry points for this site. Entry points are the base HTTP requests the WhiteHat scanner uses to test the site.",
        "operationId": "addEntryPoints",
        "parameters": [
          {
            "name": "site_id",
            "in": "path",
            "description": "Site ID.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "format",
            "in": "query",
            "description": "The response representation format for results.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string",
              "default": "xml",
              "example": "json",
              "enum": [
                "json",
                "xml"
              ]
            }
          }
        ],
        "requestBody": {
          "description": "Holds the entry point URLs for a particular site.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EntryPointsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "201": {
            "description": "Provides the entry point URLs for a particular site.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteEntryPoints"
                }
              },
              "application/xml": {
                "example": "XML preview is currently not supported."
              }
            }
          },
          "400": {
            "description": "BadRequestResponse indicates a request with invalid parameters.",
            "content": {}
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access.",
            "content": {}
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized.",
            "content": {}
          },
          "500": {
            "description": "GenericError generic error.",
            "content": {}
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "schemas": {
      "SiteEntryPoint": {
        "properties": {
          "id": {
            "type": "number"
          },
          "method": {
            "type": "string"
          },
          "date_added_t": {
            "type": "string",
            "nullable": true
          },
          "creator_id": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "number"
              }
            ]
          },
          "uri": {
            "type": "string"
          },
          "maker": {
            "type": "string"
          },
          "href": {
            "type": "string"
          },
          "content": {
            "type": "string"
          }
        }
      },
      "SiteEntryPoints": {
        "properties": {
          "entry_points": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SiteEntryPoint"
            }
          },
          "href": {
            "type": "string"
          }
        }
      },
      "EntryPointRequest": {
        "required": [
          "uri"
        ],
        "properties": {
          "method": {
            "type": "string",
            "description": "HTTP method to be used for the request on this entry point.",
            "enum": [
              "GET",
              "POST"
            ]
          },
          "uri": {
            "type": "string",
            "description": "Uniform Resource Identifier - this is the URL you want to have tested. EXAMPLES: 'http://foo.com/login.php', 'http://foo.com/bar?param=1'. NOTE: The 'host' portion of this URI ('foo.com' in the examples given) must match the host in the base URL of the site or one of the site's allowed hosts."
          },
          "content": {
            "type": "string",
            "description": "Desired content for POST requests on this entry point."
          }
        }
      },
      "EntryPointsRequest": {
        "properties": {
          "site": {
            "type": "object",
            "description": "The site object containing the entry point data to be added.",
            "properties": {
              "entry_points": {
                "type": "array",
                "description": "The list of entry points to be added.",
                "items": {
                  "$ref": "#/components/schemas/EntryPointRequest"
                }
              }
            }
          }
        }
      }
    }
  }
}
```