Skip to content
Wowza Streaming Engine
/
REST API Reference
/
/
Get user

Wowza Streaming Engine REST API (2.0.0)

Complete REST API for Wowza Streaming Engine. Auto-converted from Swagger 1.2 (http://localhost:8089/swagger.json) to OpenAPI 3.0.3 for public documentation.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.wowza.com/docs/wowza-streaming-engine-rest-api
License
Wowza Media Systems
Languages
Servers
Wowza Streaming Engine Server
http://localhost:8087

Applications

Operations

Machine Stats

Operations

Server Licenses

Operations

Server Listeners

Operations

Server log4j system

Operations

Server MediaCache

Operations

Server MediaCache Version 3

Operations

Server MediaCasters

Operations

Server Monitoring

Operations

Server Publishers

Operations

Server Publishers Version 3

Operations

REST information

Operations

Servers Configuration

Operations

Server Status

Operations

Server Transcoder

Operations

Server Tuning

Operations

Server Users

Operations

Get user list

Request

Retrieves the list of server users. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users'

Responses

Successful response

Bodyapplication/json
serverNamestringrequired
saveFieldListArray of strings
versionstringrequired
usersArray of objects(UserConfig)required
users[].​passwordstringrequired
users[].​passwordEncodingstringrequired
users[].​serverNamestringrequired
users[].​descriptionstringrequired
users[].​groupsArray of stringsrequired
users[].​realmstringrequired
users[].​saveFieldListArray of strings
users[].​userNamestringrequired
users[].​versionstringrequired
Response
application/json
{
  "serverName": "string",
  "saveFieldList": [
    "string"
  ],
  "version": "string",
  "users": [
    { … }
  ]
}

Update user list

Request

Adds a new server user to the list. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
Bodyapplication/jsonrequired
passwordstringrequired
passwordEncodingstringrequired
serverNamestringrequired
descriptionstringrequired
groupsArray of stringsrequired
realmstringrequired
saveFieldListArray of strings
userNamestringrequired
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "passwordEncoding": "string",
    "serverName": "string",
    "description": "string",
    "groups": [
      "string"
    ],
    "realm": "string",
    "saveFieldList": [
      "string"
    ],
    "userName": "string",
    "version": "string"
  }'

Responses

Successful response

Get user

Request

Retrieves the specified user configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
userNamestringrequired

The user name

curl -i -X GET \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users/{userName}'

Responses

Successful response

Bodyapplication/json
passwordstringrequired
passwordEncodingstringrequired
serverNamestringrequired
descriptionstringrequired
groupsArray of stringsrequired
realmstringrequired
saveFieldListArray of strings
userNamestringrequired
versionstringrequired
Response
application/json
{
  "password": "string",
  "passwordEncoding": "string",
  "serverName": "string",
  "description": "string",
  "groups": [
    "string"
  ],
  "realm": "string",
  "saveFieldList": [
    "string"
  ],
  "userName": "string",
  "version": "string"
}

Update user

Request

Updates the specified user configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
userNamestringrequired

The user name

Bodyapplication/jsonrequired
passwordstringrequired
passwordEncodingstringrequired
serverNamestringrequired
descriptionstringrequired
groupsArray of stringsrequired
realmstringrequired
saveFieldListArray of strings
userNamestringrequired
versionstringrequired
curl -i -X PUT \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users/{userName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "passwordEncoding": "string",
    "serverName": "string",
    "description": "string",
    "groups": [
      "string"
    ],
    "realm": "string",
    "saveFieldList": [
      "string"
    ],
    "userName": "string",
    "version": "string"
  }'

Responses

Successful response

Create user

Request

Adds the specified user configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
userNamestringrequired

The user name

Bodyapplication/jsonrequired
passwordstringrequired
passwordEncodingstringrequired
serverNamestringrequired
descriptionstringrequired
groupsArray of stringsrequired
realmstringrequired
saveFieldListArray of strings
userNamestringrequired
versionstringrequired
curl -i -X POST \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users/{userName}' \
  -H 'Content-Type: application/json' \
  -d '{
    "password": "string",
    "passwordEncoding": "string",
    "serverName": "string",
    "description": "string",
    "groups": [
      "string"
    ],
    "realm": "string",
    "saveFieldList": [
      "string"
    ],
    "userName": "string",
    "version": "string"
  }'

Responses

Successful response

Delete user

Request

Deletes the specified user configuration. This API is available in builds 15089 or later.

Security
basicAuth
Path
serverNamestringrequired

Reserved for future use

Default "_defaultServer_"
userNamestringrequired

The user name

curl -i -X DELETE \
  -u <username>:<password> \
  'http://localhost:8087/v2/servers/{serverName}/users/{userName}'

Responses

Successful response

Virtual Hosts

Operations

Webhooks

Operations