f5-conx-core

{ "openapi": "3.0.2", "info": { "title": "Draft BIG-IP Next API Specification", "version": "208.23.2", "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" } }, "servers": [ { "url": "https://api.big-ip-next.f5.com/api/v1", "description": "The only thing matters for now is the base path: /api/v1" } ], "paths": { "/gui": { "get": { "servers": [ { "url": "https://api.big-ip-next.f5.com", "description": "The base URL to get to GUI server." } ], "operationId": "getUiIndex", "description": "Get UI index file.", "responses": { "200": { "description": "OK" } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] } }, "/gui/{uiPath}": { "parameters": [ { "name": "uiPath", "in": "path", "required": true, "description": "The Path to UI resource files such as htm and js files.", "schema": { "type": "string", "pattern": ".*" } } ], "get": { "servers": [ { "url": "https://api.big-ip-next.f5.com", "description": "The base URL to get to GUI server." } ], "operationId": "getUiResources", "description": "Get various UI resource files.", "responses": { "200": { "description": "OK" } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] } }, "/applications": { "get": { "summary": "List all applications", "description": "List all applications.", "operationId": "getApplications", "tags": [ "Application" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Application" } }, "examples": { "get_applications": { "$ref": "#/components/examples/get_applications" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Applications" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] }, "put": { "summary": "Add a new application", "description": "Add a new application.", "operationId": "createApplication", "tags": [ "Application" ], "requestBody": { "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Application" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application" }, "examples": { "put_application": { "$ref": "#/components/examples/create_or_update_application" }, "put_multi_host_tls_application": { "$ref": "#/components/examples/create_or_update_multi_host_tls_application" } } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } } }, "/applications/{appId}": { "parameters": [ { "name": "appId", "in": "path", "description": "The application ID.", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" }, "example": "86657e15-439d-4cef-97bc-58a6c119976b" } ], "get": { "summary": "Get an application", "description": "Get an application.", "operationId": "getApplication", "tags": [ "Application" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" }, "examples": { "get_application": { "$ref": "#/components/examples/get_application" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Application" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] }, "put": { "summary": "Update an application", "description": "Update an application.", "operationId": "updateApplication", "tags": [ "Application" ], "requestBody": { "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Application" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Application" }, "examples": { "put_application_by_id": { "$ref": "#/components/examples/create_or_update_application" } } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } }, "delete": { "summary": "Delete an application", "description": "Delete an application.", "operationId": "removeApplication", "tags": [ "Application" ], "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } } }, "/applications/{appId}/stacks": { "parameters": [ { "name": "appId", "in": "path", "description": "The application ID.", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" }, "example": "86657e15-439d-4cef-97bc-58a6c119976b" } ], "get": { "summary": "List all stacks", "description": "List all stacks.", "operationId": "getStacks", "tags": [ "Application" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Stack" } }, "examples": { "get_stacks": { "$ref": "#/components/examples/get_stacks" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Stacks" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] }, "put": { "summary": "Create a stack", "description": "Create a stack.", "operationId": "createStack", "tags": [ "Application" ], "requestBody": { "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Stack" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Stack" }, "examples": { "put_stack": { "$ref": "#/components/examples/create_or_update_stack" } } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } } }, "/applications/{appId}/stacks/{stackId}": { "parameters": [ { "name": "appId", "in": "path", "description": "The application ID.", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" }, "example": "86657e15-439d-4cef-97bc-58a6c119976b" }, { "in": "path", "name": "stackId", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" }, "example": "128e8854-f886-44ea-9b24-ba34d203e419", "description": "The network ID." } ], "get": { "summary": "Get a stack", "description": "Get a stack.", "operationId": "getStack", "tags": [ "Application" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stack" }, "examples": { "get_stack": { "$ref": "#/components/examples/get_stack" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Stack" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] }, "put": { "summary": "Update a stack by ID", "description": "Update a stack by ID.", "operationId": "updateStack", "tags": [ "Application" ], "requestBody": { "content": { "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Stack" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Stack" }, "examples": { "update_stack_by_id": { "$ref": "#/components/examples/create_or_update_stack" } } } }, "required": true }, "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } }, "delete": { "summary": "Delete a stack", "description": "Delete a stack.", "operationId": "removeStack", "tags": [ "Application" ], "responses": { "202": { "$ref": "#/components/responses/JobAccepted" } } } }, "/jobs": { "get": { "summary": "List all jobs", "description": "List all jobs.", "operationId": "getJobs", "tags": [ "Job" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Jobs" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] } }, "/jobs/{jobId}": { "parameters": [ { "name": "jobId", "in": "path", "description": "The job ID.", "required": true, "schema": { "$ref": "#/components/schemas/Uuid" } } ], "get": { "summary": "Get a job", "description": "Get a job.", "operationId": "getJobById", "tags": [ "Job" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.Job" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] } }, "/L1-networks": { "get": { "summary": "Retrieve the current collection of L1-network objects.", "description": "A collection of L1-network objects.", "operationId": "getL1Networks", "tags": [ "L1-network" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/L1Network" } } }, "application/hal+json": { "schema": { "$ref": "#/components/schemas/hal.L1Networks" } } } } }, "parameters": [ { "in": "query", "name": "where", "description": "Where query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "fields", "description": "Fields query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "offset", "description": "Offset query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "limit", "description": "Limit query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "skip", "description": "Skip query parameter.", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "in": "query", "name": "order", "description": "Order query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "include", "description": "Include query parameter.", "schema": { "type": "array", "items": { "type": "string", "maxLength": 64000 } } }, { "in": "query", "name": "sort", "description": "Sort query parameter.", "schema": { "type": "string", "maxLength": 64000 } } ] }, "put": { "summary": "Update the collection with a new L1-network object.", "description": "A collection of L1-network objects.", "operationId": "updateL1Networks", "tags": [ "L1-network" ],