---
title: "Creates an endpoint"
method: POST
path: "/api/v1/environments/endpoints"
tags: ["Environment"]
---

# Creates an endpoint

`POST /api/v1/environments/endpoints`

## Request

- Base URL: `https://docs.anzworldline-solutions.com.au`
- URL: `https://docs.anzworldline-solutions.com.au/api/v1/environments/endpoints`
- Auth: none declared
- TypeScript: <https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/environments/endpoints/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body `*/*`

- EndpointForm
  - `name` string, required
  - `protocol` string, required
  - `address` string, required
  - `port` string, required
  - `authorizationToken` string
  - `enabled` boolean
  - `sending` boolean
  - `environmentId` string, required

## Response `200`

If creation is successfully.

- ResponseEntityEndpointView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` PublishingEndPoint
    - `id` string
    - `groupId` string
    - `serverName` object
      - `empty` boolean
      - `length` integer
    - `address` string
    - `port` string
    - `protocol` string
    - `enabled` boolean
    - `authKey` object
      - `empty` boolean
      - `length` integer
    - `sending` boolean
    - `tokenExpired` boolean
    - `tokenInvalid` boolean
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `400`: If the endpoint already exits
- `403`: If the user is not an admin or access to the configuration layout or does have permission, it will return a 403.

## Changes

- **2026-10-30** `4fd8e917d458`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/changes/api/v1/environments/endpoints/post.md)

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) - [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/revisions/4fd8e917d458?raw)