{"type":"api","title":"Create Panorama connector","meta":{"id":"/apps/pubhub/media/000-v7-apis/a9d7d077fd3cd26af5968939669b4553e8957e87/68c48c74-33c8-3d31-92e9-0dd1508b00a3","info":{"title":"Integrations API","description":"**Note:** The Webhook Operations APIs are not available for ThousandEyes for Government instance.\n\nManage connectors and operations.\n","version":"7.0.107"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Credential Vault Operations","description":"Credential Vault operations allow you to configure vault secrets."},{"name":"Operation Connectors","description":"Manage the connectors assigned to an operation."},{"name":"CyberArk Conjur Connectors","description":"The CyberArk Conjur instance you want the ThousandEyes platform to integrate with."},{"name":"Webhook Operations","description":"Webhook operations allow you to customize the payload of generic connectors."},{"name":"Generic Connectors","description":"A generic connector represents an instance of a third-party service that you can integrate with the ThousandEyes platform."},{"name":"Panorama Connectors","description":"A Panorama connector represents an instance of Palo Alto Networks Panorama that you can integrate with the ThousandEyes platform."}],"openapi":"3.0.1","servers":[{"url":"https://api.thousandeyes.com/v7","description":"ThousandEyes API v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"tags":["Panorama Connectors"],"summary":"Create Panorama connector","description":"Creates a new Panorama connector.","operationId":"createPanoramaConnector","parameters":[{"name":"aid","in":"query","description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.","required":false,"schema":{"type":"string","example":"1234"},"$$ref":"#/components/parameters/AccountGroupId"}],"requestBody":{"description":"Panorama connector configuration.","content":{"application/json":{"schema":{"description":"Palo Alto Networks Panorama connector configuration.","required":["authentication","name","target","type"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Panorama connector.","readOnly":true,"example":"cb1b8033-ea2d-4e9b-a920-fe87850693cf"},"type":{"type":"string","description":"Connector type.","enum":["panorama"],"example":"panorama"},"name":{"type":"string","description":"Name of the Panorama connector.","example":"Branch Panorama"},"target":{"type":"string","description":"URL of the Panorama instance.","example":"https://panorama.example.com"},"lastModifiedDate":{"type":"integer","description":"Time when the connector was last modified, in milliseconds since the Unix epoch.","format":"int64","readOnly":true,"example":1770293655756},"authentication":{"type":"object","description":"Authentication configuration for the Panorama connector.","discriminator":{"propertyName":"type","mapping":{"other-token":"#/components/schemas/PanoramaTokenAuthentication","pan-key-gen":"#/components/schemas/PanoramaKeyGenAuthentication"}},"oneOf":[{"required":["token","type"],"type":"object","description":"Authentication using an existing Panorama API key.","properties":{"token":{"type":"string","description":"Panorama API key used for authentication.","writeOnly":true},"type":{"type":"string","description":"Authentication type.","enum":["other-token"]}},"$$ref":"#/components/schemas/PanoramaTokenAuthentication"},{"required":["keyTtl","password","type","username"],"type":"object","description":"Authentication using credentials to generate a Panorama API key.","properties":{"username":{"type":"string","description":"Username used to generate the Panorama API key.","example":"panorama-user"},"password":{"type":"string","description":"Password used to generate the Panorama API key.","format":"password","writeOnly":true},"keyTtl":{"type":"integer","description":"Time to live for the generated Panorama API key, in minutes.","format":"int64","minimum":30,"example":40},"type":{"type":"string","enum":["pan-key-gen"]}},"$$ref":"#/components/schemas/PanoramaKeyGenAuthentication"}],"$$ref":"#/components/schemas/PanoramaConnectorAuth"},"_links":{"type":"object","description":"A links object containing the self link.","readOnly":true,"properties":{"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/SelfLinks"}},"$$ref":"#/components/schemas/PanoramaConnector"},"example":{"type":"panorama","name":"Branch Panorama","target":"https://panorama.example.com","authentication":{"username":"panorama-user","password":"\u003cpanorama-password\u003e","keyTtl":40,"type":"pan-key-gen"}}}},"required":true},"responses":{"201":{"description":"The created Panorama connector.","content":{"application/hal+json":{"schema":{"description":"Palo Alto Networks Panorama connector configuration.","required":["authentication","name","target","type"],"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the Panorama connector.","readOnly":true,"example":"cb1b8033-ea2d-4e9b-a920-fe87850693cf"},"type":{"type":"string","description":"Connector type.","enum":["panorama"],"example":"panorama"},"name":{"type":"string","description":"Name of the Panorama connector.","example":"Branch Panorama"},"target":{"type":"string","description":"URL of the Panorama instance.","example":"https://panorama.example.com"},"lastModifiedDate":{"type":"integer","description":"Time when the connector was last modified, in milliseconds since the Unix epoch.","format":"int64","readOnly":true,"example":1770293655756},"authentication":{"type":"object","description":"Authentication configuration for the Panorama connector.","discriminator":{"propertyName":"type","mapping":{"other-token":"#/components/schemas/PanoramaTokenAuthentication","pan-key-gen":"#/components/schemas/PanoramaKeyGenAuthentication"}},"oneOf":[{"required":["token","type"],"type":"object","description":"Authentication using an existing Panorama API key.","properties":{"token":{"type":"string","description":"Panorama API key used for authentication.","writeOnly":true},"type":{"type":"string","description":"Authentication type.","enum":["other-token"]}},"$$ref":"#/components/schemas/PanoramaTokenAuthentication"},{"required":["keyTtl","password","type","username"],"type":"object","description":"Authentication using credentials to generate a Panorama API key.","properties":{"username":{"type":"string","description":"Username used to generate the Panorama API key.","example":"panorama-user"},"password":{"type":"string","description":"Password used to generate the Panorama API key.","format":"password","writeOnly":true},"keyTtl":{"type":"integer","description":"Time to live for the generated Panorama API key, in minutes.","format":"int64","minimum":30,"example":40},"type":{"type":"string","enum":["pan-key-gen"]}},"$$ref":"#/components/schemas/PanoramaKeyGenAuthentication"}],"$$ref":"#/components/schemas/PanoramaConnectorAuth"},"_links":{"type":"object","description":"A links object containing the self link.","readOnly":true,"properties":{"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/SelfLinks"}},"$$ref":"#/components/schemas/PanoramaConnector"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."},"errors":{"nullable":true,"type":"array","description":"(Optional) When multiple errors occur, the details for each error are listed.","items":{"type":"object","properties":{"code":{"type":"string","description":"(Optional) A unique error type/code that can be referenced in the documentation for further details."},"field":{"type":"string","description":"Identifies the field that triggered this particular error."},"message":{"type":"string","description":"A short, human-readable summary of the error."}},"$$ref":"#/components/schemas/ValidationErrorItem"}}},"$$ref":"#/components/schemas/ValidationError"},"example":{"type":"about:blank","title":"Request validation failed. There are invalid or missing fields","status":400,"detail":"Your request object contains invalid fields.","instance":"/v7","errors":[{"code":"AM-5432","field":"firstName","message":"firstName cannot have fancy characters"},{"code":"DASH-5622","field":"password","message":"Password cannot be blank"}]}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid_token"},"error_description":{"type":"string","example":"Invalid access token"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/401"},"403":{"description":"Insufficient permissions to query endpoint","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/403"},"404":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"URI Resource Not Found","status":404,"detail":"Details explaining if the 404 error is related to an invalid URI or a wrong ID","instance":"/v7"}}},"$$ref":"#/components/responses/404"},"500":{"description":"Internal server error","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"}}},"$$ref":"#/components/responses/500"}},"__originalOperationId":"createPanoramaConnector","security":[{"BearerAuth":[]}],"method":"post","path":"/connectors/panorama"}}