nginx-proxy-manager/backend/schema/paths/nginx/access-lists/post.json

{
	"operationId": "createAccessList",
	"summary": "Create a Access List",
	"tags": ["access-lists"],
	"security": [
		{
			"bearerAuth": [
				"access_lists.manage"
			]
		}
	],
	"requestBody": {
		"description": "Access List Payload",
		"required": true,
		"content": {
			"application/json": {
				"schema": {
					"type": "object",
					"additionalProperties": false,
					"required": [
						"name"
					],
					"properties": {
						"name": {
							"$ref": "../../../components/access-list-object.json#/properties/name"
						},
						"satisfy_any": {
							"$ref": "../../../components/access-list-object.json#/properties/satisfy_any"
						},
						"pass_auth": {
							"$ref": "../../../components/access-list-object.json#/properties/pass_auth"
						},
						"items": {
							"$ref": "../../../common.json#/properties/access_items"
						},
						"clients": {
							"$ref": "../../../common.json#/properties/access_clients"
						}
					}
				},
				"example": {
					"name": "My Access List",
					"satisfy_any": true,
					"pass_auth": false,
					"items": [
						{
							"username": "admin",
							"password": "pass"
						}
					],
					"clients": [
						{
							"directive": "allow",
							"address": "192.168.0.0/24"
						}
					]
				}
			}
		}
	},
	"responses": {
		"201": {
			"description": "201 response",
			"content": {
				"application/json": {
					"examples": {
						"default": {
							"value": {
								"id": 1,
								"created_on": "2024-10-08T22:15:40.000Z",
								"modified_on": "2024-10-08T22:15:40.000Z",
								"owner_user_id": 1,
								"name": "test1234",
								"meta": {},
								"satisfy_any": true,
								"pass_auth": false,
								"proxy_host_count": 0,
								"owner": {
									"id": 1,
									"created_on": "2024-10-07T22:43:55.000Z",
									"modified_on": "2024-10-08T12:52:54.000Z",
									"is_disabled": false,
									"email": "admin@example.com",
									"name": "Administrator",
									"nickname": "some guy",
									"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
									"roles": [
										"admin"
									]
								},
								"items": [
									{
										"id": 1,
										"created_on": "2024-10-08T22:15:40.000Z",
										"modified_on": "2024-10-08T22:15:40.000Z",
										"access_list_id": 1,
										"username": "admin",
										"password": "",
										"meta": {},
										"hint": "a****"
									},
									{
										"id": 2,
										"created_on": "2024-10-08T22:15:40.000Z",
										"modified_on": "2024-10-08T22:15:40.000Z",
										"access_list_id": 1,
										"username": "asdad",
										"password": "",
										"meta": {},
										"hint": "a*****"
									}
								],
								"proxy_hosts": [],
								"clients": [
									{
										"id": 1,
										"created_on": "2024-10-08T22:15:40.000Z",
										"modified_on": "2024-10-08T22:15:40.000Z",
										"access_list_id": 1,
										"address": "127.0.0.1",
										"directive": "allow",
										"meta": {}
									}
								]
							}
						}
					},
					"schema": {
						"$ref": "../../../components/access-list-object.json"
					}
				}
			}
		}
	}
}