---
title: "Create web service definition"
method: POST
path: "/v1/web-service-definitions"
tags: ["Web Service Definitions"]
---

# Create web service definition

`POST /v1/web-service-definitions`

Create a new web service definition. Name and URL are required.

## Request body

- WebServiceDefinitionCreate
  - `name` string, required — Definition name
  - `description` string — Definition description
  - `url` string, required — Web service URL
  - `httpRequestMethod` integer — HTTP request method (0=GET, 1=POST, 2=PUT, 3=DELETE, 4=PATCH)
  - `requestData` string — Request body data
  - `flags` integer — Flags (bit mask: 1=verify certificate, 2=verify host, 4=force plain text parser, 8=follow location)
  - `authType` integer — Authentication type (0=none, 1=basic, 2=digest, 3=NTLM, 4=bearer, 5=any)
  - `login` string — Login name or token
  - `password` string — Password
  - `cacheRetentionTime` integer — Cache retention time in milliseconds
  - `requestTimeout` integer — Request timeout in milliseconds (default 30000)
  - `headers` object[] — HTTP headers
    - `name` string
    - `value` string

## Response `201`

Web service definition created successfully

- WebServiceDefinition
  - `id` integer — Web service definition ID
  - `guid` string — Web service definition GUID
  - `name` string — Definition name
  - `description` string — Definition description
  - `url` string — Web service URL (may contain %1, %2, etc. for parameter substitution)
  - `httpRequestMethod` integer — HTTP request method (0=GET, 1=POST, 2=PUT, 3=DELETE, 4=PATCH)
  - `requestData` string — Request body data
  - `flags` integer — Flags (bit mask: 1=verify certificate, 2=verify host, 4=force plain text parser, 8=follow location)
  - `authType` integer — Authentication type (0=none, 1=basic, 2=digest, 3=NTLM, 4=bearer, 5=any)
  - `login` string — Login name or token
  - `password` string — Password
  - `cacheRetentionTime` integer — Cache retention time in milliseconds
  - `requestTimeout` integer — Request timeout in milliseconds
  - `headers` object[] — HTTP headers
    - `name` string
    - `value` string

## Other responses

- `400` — Invalid request (missing name or url)
- `401` — Unauthorized
- `403` — User does not have web service definitions access rights
- `409` — Web service definition with this name already exists

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/14d93e5115dd/schema)