diff --git a/packages/openapi-parser/tests/files/azurecomapimanagement-apimproducts.yaml b/packages/openapi-parser/tests/files/azurecomapimanagement-apimproducts.yaml deleted file mode 100644 index 772a10a..0000000 --- a/packages/openapi-parser/tests/files/azurecomapimanagement-apimproducts.yaml +++ /dev/null @@ -1,4366 +0,0 @@ -swagger: "2.0" -schemes: - - https -host: management.azure.com -info: - description: Use these REST APIs for performing operations on Product entity associated with your Azure API Management deployment. The Product entity represents a product in API Management. Products include one or more APIs and their associated terms of use. Once a product is published, developers can subscribe to the product and begin to use the product’s APIs. - title: ApiManagementClient - version: 2019-12-01-preview - x-apisguru-categories: - - cloud - x-logo: - url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png - x-origin: - - format: swagger - url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimproducts.json - version: "2.0" - x-preferred: true - x-providerName: azure.com - x-serviceName: apimanagement-apimproducts - x-tags: - - Azure - - Microsoft -consumes: - - application/json -produces: - - application/json -securityDefinitions: - azure_auth: - authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize - description: Azure Active Directory OAuth2 Flow. - flow: implicit - scopes: - user_impersonation: impersonate your user account - type: oauth2 -security: - - azure_auth: - - user_impersonation -parameters: {} -paths: - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products": - get: - description: Lists a collection of products in the specified service instance. - operationId: Product_ListByService - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| groups | expand | | |
" - in: query - name: $filter - required: false - type: string - - description: Number of records to return. - format: int32 - in: query - minimum: 1 - name: $top - required: false - type: integer - x-ms-parameter-location: method - - description: Number of records to skip. - format: int32 - in: query - minimum: 0 - name: $skip - required: false - type: integer - x-ms-parameter-location: method - - description: When set to true, the response contains an array of groups that have visibility to the product. The default is false. - in: query - name: expandGroups - required: false - type: boolean - - description: Products which are part of a specific tag. - in: query - name: tags - required: false - type: string - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: A Collection of the Product entities for the specified API Management service instance. - schema: - description: Paged Products list representation. - properties: - nextLink: - description: Next page link if any. - type: string - value: - description: Page values. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Product details. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Product profile. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - required: - - displayName - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementListProducts: - parameters: - api-version: 2019-12-01-preview - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmtemplateCert1 - name: kjoshiarmtemplateCert1 - properties: - description: Development Product - displayName: Dev - state: published - subscriptionRequired: false - type: Microsoft.ApiManagement/service/products - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/starter - name: starter - properties: - approvalRequired: false - description: Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week. - displayName: Starter - state: published - subscriptionRequired: true - subscriptionsLimit: 1 - terms: "" - type: Microsoft.ApiManagement/service/products - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited - name: unlimited - properties: - approvalRequired: true - description: Subscribers have completely unlimited access to the API. Administrator approval is required. - displayName: Unlimited - state: published - subscriptionRequired: true - subscriptionsLimit: 1 - type: Microsoft.ApiManagement/service/products - x-ms-odata: ./definitions.json#/definitions/ProductContract - x-ms-pageable: - nextLinkName: nextLink - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}": - delete: - description: Delete product. - operationId: Product_Delete - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. - in: header - name: If-Match - required: true - type: string - x-ms-parameter-location: method - - description: Delete existing subscriptions associated with the product or not. - in: query - name: deleteSubscriptions - required: false - type: boolean - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product was successfully removed. - "204": - description: Product was successfully removed by previous request or does not exist. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementDeleteProduct: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - deleteSubscriptions: true - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": {} - "204": {} - get: - description: Gets the details of the product specified by its identifier. - operationId: Product_Get - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The response body contains the specified Product entity. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Product details. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Product profile. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - required: - - displayName - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementGetProduct: - parameters: - api-version: 2019-12-01-preview - productId: unlimited - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited - name: unlimited - properties: - approvalRequired: true - description: Subscribers have completely unlimited access to the API. Administrator approval is required. - displayName: Unlimited - state: published - subscriptionRequired: true - subscriptionsLimit: 1 - type: Microsoft.ApiManagement/service/products - head: - description: Gets the entity state (Etag) version of the product specified by its identifier. - operationId: Product_GetEntityTag - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Specified Product entity exists and current entity state version is present in the ETag header. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementHeadProduct: - parameters: - api-version: 2019-12-01-preview - productId: unlimited - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - headers: - etag: AAAAAAAAAAa= - patch: - description: Update existing product details. - operationId: Product_Update - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Update parameters. - in: body - name: parameters - required: true - schema: - description: Product Update parameters. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Parameters supplied to the Update Product operation. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - - description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. - in: header - name: If-Match - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "204": - description: Product details was successfully updated. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementUpdateProduct: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - parameters: - properties: - displayName: Test Template ProductName 4 - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "204": {} - put: - description: Creates or Updates a product. - operationId: Product_CreateOrUpdate - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Create or update parameters. - in: body - name: parameters - required: true - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Product details. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Product profile. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - required: - - displayName - - description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - in: header - name: If-Match - required: false - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product was successfully updated. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Product details. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Product profile. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - required: - - displayName - "201": - description: Product was successfully created. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Product details. - properties: - properties: - allOf: - - description: Product Entity Base Parameters - properties: - approvalRequired: - description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. - type: boolean - description: - description: Product description. May include HTML formatting tags. - maxLength: 1000 - minLength: 1 - type: string - state: - description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. - enum: - - notPublished - - published - type: string - x-ms-enum: - modelAsString: false - name: ProductState - subscriptionRequired: - description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. - type: boolean - subscriptionsLimit: - description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. - format: int32 - type: integer - terms: - description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. - type: string - description: Product profile. - properties: - displayName: - description: Product name. - maxLength: 300 - minLength: 1 - type: string - required: - - displayName - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - Product - x-ms-examples: - ApiManagementCreateProduct: - parameters: - api-version: 2019-12-01-preview - parameters: - properties: - displayName: Test Template ProductName 4 - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct - name: testproduct - properties: - approvalRequired: false - displayName: Test Template ProductName 4 - state: notPublished - subscriptionRequired: true - type: Microsoft.ApiManagement/service/products - "201": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct - name: testproduct - properties: - approvalRequired: false - displayName: Test Template ProductName 4 - state: notPublished - subscriptionRequired: true - type: Microsoft.ApiManagement/service/products - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis": - get: - description: Lists a collection of the APIs associated with a product. - operationId: ProductApi_ListByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - in: query - name: $filter - required: false - type: string - - description: Number of records to return. - format: int32 - in: query - minimum: 1 - name: $top - required: false - type: integer - x-ms-parameter-location: method - - description: Number of records to skip. - format: int32 - in: query - minimum: 0 - name: $skip - required: false - type: integer - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The response body contains a collection of Api entities in the product. - schema: - description: Paged Api list representation. - properties: - nextLink: - description: Next page link if any. - readOnly: true - type: string - value: - description: Page values. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Api details. - properties: - properties: - allOf: - - description: API base contract details. - properties: - apiRevision: - description: Describes the Revision of the Api. If no value is provided, default revision 1 is created - maxLength: 100 - minLength: 1 - type: string - apiRevisionDescription: - description: Description of the Api Revision. - maxLength: 256 - type: string - apiVersion: - description: Indicates the Version identifier of the API if the API is versioned - maxLength: 100 - type: string - apiVersionDescription: - description: Description of the Api Version. - maxLength: 256 - type: string - apiVersionSetId: - description: A resource identifier for the related ApiVersionSet. - type: string - authenticationSettings: - description: API Authentication Settings. - properties: - oAuth2: - description: API OAuth2 Authentication settings details. - properties: - authorizationServerId: - description: OAuth authorization server identifier. - type: string - scope: - description: operations scope. - type: string - openid: - description: API OAuth2 Authentication settings details. - properties: - bearerTokenSendingMethods: - description: How to send token to the server. - items: - description: Form of an authorization grant, which the client uses to request the access token. - enum: - - authorizationHeader - - query - type: string - x-ms-enum: - modelAsString: true - name: bearerTokenSendingMethods - values: - - description: Access token will be transmitted in the Authorization header using Bearer schema - value: authorizationHeader - - description: Access token will be transmitted as query parameters. - value: query - type: array - openidProviderId: - description: OAuth authorization server identifier. - type: string - description: - description: Description of the API. May include HTML formatting tags. - type: string - isCurrent: - description: Indicates if API revision is current api revision. - type: boolean - isOnline: - description: Indicates if API revision is accessible via the gateway. - readOnly: true - type: boolean - subscriptionKeyParameterNames: - description: Subscription key parameter names details. - example: - subscriptionKeyParameterNames: - header: customHeaderParameterName - query: customQueryParameterName - properties: - header: - description: Subscription key header name. - type: string - query: - description: Subscription key query string parameter name. - type: string - subscriptionRequired: - description: Specifies whether an API or Product subscription is required for accessing the API. - type: boolean - type: - description: Type of API. - enum: - - http - - soap - type: string - x-ms-client-name: ApiType - x-ms-enum: - modelAsString: true - name: ApiType - description: Api Entity Properties - properties: - apiVersionSet: - description: "An API Version Set contains the common configuration for a set of API Versions relating " - properties: - description: - description: Description of API Version Set. - type: string - id: - description: Identifier for existing API Version Set. Omit this value to create a new Version Set. - type: string - name: - description: The display Name of the API Version Set. - type: string - versionHeaderName: - description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. - type: string - versionQueryName: - description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - type: string - versioningScheme: - description: An value that determines where the API Version identifer will be located in a HTTP request. - enum: - - Segment - - Query - - Header - type: string - displayName: - description: API name. Must be 1 to 300 characters long. - maxLength: 300 - minLength: 1 - type: string - path: - description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - maxLength: 400 - minLength: 0 - type: string - protocols: - description: Describes on which protocols the operations in this API can be invoked. - items: - enum: - - http - - https - type: string - x-ms-enum: - modelAsString: false - name: Protocol - type: array - serviceUrl: - description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - maxLength: 2000 - minLength: 0 - type: string - sourceApiId: - description: API identifier of the source API. - type: string - required: - - path - readOnly: true - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductApi - x-ms-examples: - ApiManagementListProductApis: - parameters: - api-version: 2019-12-01-preview - productId: 5768181ea40f7eb6c49f6ac7 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca - name: 57681820a40f7eb6c49f6aca - properties: - apiRevision: "1" - description: description_57681820a40f7eb6c49f6acc - displayName: api_57681820a40f7eb6c49f6acb - isCurrent: true - path: suffix_57681820a40f7eb6c49f6ace - protocols: - - https - serviceUrl: http://contoso/57681820a40f7eb6c49f6acd - type: Microsoft.ApiManagement/service/products/apis - x-ms-odata: ./definitions.json#/definitions/ApiContract - x-ms-pageable: - nextLinkName: nextLink - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}": - delete: - description: Deletes the specified API from the specified product. - operationId: ProductApi_Delete - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - in: path - maxLength: 256 - minLength: 1 - name: apiId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: API was successfully removed from product - "204": - description: API successfully removed by previous request or does not exist in product - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductApi - x-ms-examples: - ApiManagementDeleteProductApi: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - apiId: echo-api - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": {} - "204": {} - head: - description: Checks that API entity specified by identifier is associated with the Product entity. - operationId: ProductApi_CheckEntityExists - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - in: path - maxLength: 256 - minLength: 1 - name: apiId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "204": - description: Entity exists - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductApi - x-ms-examples: - ApiManagementHeadProductApi: - parameters: - api-version: 2019-12-01-preview - apiId: 59306a29e4bbd510dc24e5f9 - productId: 5931a75ae4bbd512a88c680b - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "204": {} - put: - description: Adds an API to the specified product. - operationId: ProductApi_CreateOrUpdate - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number. - in: path - maxLength: 256 - minLength: 1 - name: apiId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The specified API is already added to the product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Api details. - properties: - properties: - allOf: - - description: API base contract details. - properties: - apiRevision: - description: Describes the Revision of the Api. If no value is provided, default revision 1 is created - maxLength: 100 - minLength: 1 - type: string - apiRevisionDescription: - description: Description of the Api Revision. - maxLength: 256 - type: string - apiVersion: - description: Indicates the Version identifier of the API if the API is versioned - maxLength: 100 - type: string - apiVersionDescription: - description: Description of the Api Version. - maxLength: 256 - type: string - apiVersionSetId: - description: A resource identifier for the related ApiVersionSet. - type: string - authenticationSettings: - description: API Authentication Settings. - properties: - oAuth2: - description: API OAuth2 Authentication settings details. - properties: - authorizationServerId: - description: OAuth authorization server identifier. - type: string - scope: - description: operations scope. - type: string - openid: - description: API OAuth2 Authentication settings details. - properties: - bearerTokenSendingMethods: - description: How to send token to the server. - items: - description: Form of an authorization grant, which the client uses to request the access token. - enum: - - authorizationHeader - - query - type: string - x-ms-enum: - modelAsString: true - name: bearerTokenSendingMethods - values: - - description: Access token will be transmitted in the Authorization header using Bearer schema - value: authorizationHeader - - description: Access token will be transmitted as query parameters. - value: query - type: array - openidProviderId: - description: OAuth authorization server identifier. - type: string - description: - description: Description of the API. May include HTML formatting tags. - type: string - isCurrent: - description: Indicates if API revision is current api revision. - type: boolean - isOnline: - description: Indicates if API revision is accessible via the gateway. - readOnly: true - type: boolean - subscriptionKeyParameterNames: - description: Subscription key parameter names details. - example: - subscriptionKeyParameterNames: - header: customHeaderParameterName - query: customQueryParameterName - properties: - header: - description: Subscription key header name. - type: string - query: - description: Subscription key query string parameter name. - type: string - subscriptionRequired: - description: Specifies whether an API or Product subscription is required for accessing the API. - type: boolean - type: - description: Type of API. - enum: - - http - - soap - type: string - x-ms-client-name: ApiType - x-ms-enum: - modelAsString: true - name: ApiType - description: Api Entity Properties - properties: - apiVersionSet: - description: "An API Version Set contains the common configuration for a set of API Versions relating " - properties: - description: - description: Description of API Version Set. - type: string - id: - description: Identifier for existing API Version Set. Omit this value to create a new Version Set. - type: string - name: - description: The display Name of the API Version Set. - type: string - versionHeaderName: - description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. - type: string - versionQueryName: - description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - type: string - versioningScheme: - description: An value that determines where the API Version identifer will be located in a HTTP request. - enum: - - Segment - - Query - - Header - type: string - displayName: - description: API name. Must be 1 to 300 characters long. - maxLength: 300 - minLength: 1 - type: string - path: - description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - maxLength: 400 - minLength: 0 - type: string - protocols: - description: Describes on which protocols the operations in this API can be invoked. - items: - enum: - - http - - https - type: string - x-ms-enum: - modelAsString: false - name: Protocol - type: array - serviceUrl: - description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - maxLength: 2000 - minLength: 0 - type: string - sourceApiId: - description: API identifier of the source API. - type: string - required: - - path - "201": - description: The API was successfully added to the product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Api details. - properties: - properties: - allOf: - - description: API base contract details. - properties: - apiRevision: - description: Describes the Revision of the Api. If no value is provided, default revision 1 is created - maxLength: 100 - minLength: 1 - type: string - apiRevisionDescription: - description: Description of the Api Revision. - maxLength: 256 - type: string - apiVersion: - description: Indicates the Version identifier of the API if the API is versioned - maxLength: 100 - type: string - apiVersionDescription: - description: Description of the Api Version. - maxLength: 256 - type: string - apiVersionSetId: - description: A resource identifier for the related ApiVersionSet. - type: string - authenticationSettings: - description: API Authentication Settings. - properties: - oAuth2: - description: API OAuth2 Authentication settings details. - properties: - authorizationServerId: - description: OAuth authorization server identifier. - type: string - scope: - description: operations scope. - type: string - openid: - description: API OAuth2 Authentication settings details. - properties: - bearerTokenSendingMethods: - description: How to send token to the server. - items: - description: Form of an authorization grant, which the client uses to request the access token. - enum: - - authorizationHeader - - query - type: string - x-ms-enum: - modelAsString: true - name: bearerTokenSendingMethods - values: - - description: Access token will be transmitted in the Authorization header using Bearer schema - value: authorizationHeader - - description: Access token will be transmitted as query parameters. - value: query - type: array - openidProviderId: - description: OAuth authorization server identifier. - type: string - description: - description: Description of the API. May include HTML formatting tags. - type: string - isCurrent: - description: Indicates if API revision is current api revision. - type: boolean - isOnline: - description: Indicates if API revision is accessible via the gateway. - readOnly: true - type: boolean - subscriptionKeyParameterNames: - description: Subscription key parameter names details. - example: - subscriptionKeyParameterNames: - header: customHeaderParameterName - query: customQueryParameterName - properties: - header: - description: Subscription key header name. - type: string - query: - description: Subscription key query string parameter name. - type: string - subscriptionRequired: - description: Specifies whether an API or Product subscription is required for accessing the API. - type: boolean - type: - description: Type of API. - enum: - - http - - soap - type: string - x-ms-client-name: ApiType - x-ms-enum: - modelAsString: true - name: ApiType - description: Api Entity Properties - properties: - apiVersionSet: - description: "An API Version Set contains the common configuration for a set of API Versions relating " - properties: - description: - description: Description of API Version Set. - type: string - id: - description: Identifier for existing API Version Set. Omit this value to create a new Version Set. - type: string - name: - description: The display Name of the API Version Set. - type: string - versionHeaderName: - description: Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. - type: string - versionQueryName: - description: Name of query parameter that indicates the API Version if versioningScheme is set to `query`. - type: string - versioningScheme: - description: An value that determines where the API Version identifer will be located in a HTTP request. - enum: - - Segment - - Query - - Header - type: string - displayName: - description: API name. Must be 1 to 300 characters long. - maxLength: 300 - minLength: 1 - type: string - path: - description: Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. - maxLength: 400 - minLength: 0 - type: string - protocols: - description: Describes on which protocols the operations in this API can be invoked. - items: - enum: - - http - - https - type: string - x-ms-enum: - modelAsString: false - name: Protocol - type: array - serviceUrl: - description: Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long. - maxLength: 2000 - minLength: 0 - type: string - sourceApiId: - description: API identifier of the source API. - type: string - required: - - path - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductApi - x-ms-examples: - ApiManagementCreateProductApi: - parameters: - api-version: 2019-12-01-preview - apiId: echo-api - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b - name: 5931a75ae4bbd512a88c680b - properties: - apiRevision: "1" - displayName: EchoApi - isCurrent: true - path: "" - protocols: - - http - - https - serviceUrl: https://contoso.com/apis/echo - subscriptionKeyParameterNames: - header: Ocp-Apim-Subscription-Key - query: subscription-key - type: Microsoft.ApiManagement/service/apis - "201": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b - name: 5931a75ae4bbd512a88c680b - properties: - apiRevision: "1" - displayName: EchoApi - isCurrent: true - path: "" - protocols: - - http - - https - serviceUrl: https://contoso.com/apis/echo - subscriptionKeyParameterNames: - header: Ocp-Apim-Subscription-Key - query: subscription-key - type: Microsoft.ApiManagement/service/apis - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups": - get: - description: Lists the collection of developer groups associated with the specified product. - operationId: ProductGroup_ListByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | |
| displayName | filter | eq, ne | |
| description | filter | eq, ne | |
" - in: query - name: $filter - required: false - type: string - - description: Number of records to return. - format: int32 - in: query - minimum: 1 - name: $top - required: false - type: integer - x-ms-parameter-location: method - - description: Number of records to skip. - format: int32 - in: query - minimum: 0 - name: $skip - required: false - type: integer - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Lists a collection of Group entities. - schema: - description: Paged Group list representation. - properties: - nextLink: - description: Next page link if any. - type: string - value: - description: Page values. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Contract details. - properties: - properties: - description: Group contract Properties. - properties: - builtIn: - description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. - readOnly: true - type: boolean - description: - description: Group description. Can contain HTML formatting tags. - maxLength: 1000 - type: string - displayName: - description: Group name. - maxLength: 300 - minLength: 1 - type: string - externalId: - description: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. - type: string - type: - description: Group type. - enum: - - custom - - system - - external - type: string - x-ms-enum: - modelAsString: false - name: GroupType - required: - - displayName - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductGroup - x-ms-examples: - ApiManagementListProductGroups: - parameters: - api-version: 2019-12-01-preview - productId: 5600b57e7e8880006a060002 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020001 - name: 5600b57e7e8880006a020001 - properties: - builtIn: true - description: Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group. - displayName: Administrators - type: system - type: Microsoft.ApiManagement/service/products/groups - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020002 - name: 5600b57e7e8880006a020002 - properties: - builtIn: true - description: Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group. - displayName: Developers - type: system - type: Microsoft.ApiManagement/service/products/groups - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/groups/5600b57e7e8880006a020003 - name: 5600b57e7e8880006a020003 - properties: - builtIn: true - description: Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group. - displayName: Guests - type: system - type: Microsoft.ApiManagement/service/products/groups - x-ms-odata: ./definitions.json#/definitions/GroupContract - x-ms-pageable: - nextLinkName: nextLink - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}": - delete: - description: Deletes the association between the specified group and product. - operationId: ProductGroup_Delete - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Group identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: groupId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The group was successfully disassociated with the product. - "204": - description: The group was successfully disassociated with the product. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductGroup - x-ms-examples: - ApiManagementDeleteProductGroup: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - groupId: templateGroup - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": {} - "204": {} - head: - description: Checks that Group entity specified by identifier is associated with the Product entity. - operationId: ProductGroup_CheckEntityExists - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Group identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: groupId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "204": - description: The Group is associated with the Product. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductGroup - x-ms-examples: - ApiManagementHeadProductGroup: - parameters: - api-version: 2019-12-01-preview - groupId: 59306a29e4bbd510dc24e5f9 - productId: 5931a75ae4bbd512a88c680b - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "204": {} - put: - description: Adds the association between the specified developer group with the specified product. - operationId: ProductGroup_CreateOrUpdate - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Group identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: groupId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The specified group is already associated with the product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Contract details. - properties: - properties: - description: Group contract Properties. - properties: - builtIn: - description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. - readOnly: true - type: boolean - description: - description: Group description. Can contain HTML formatting tags. - maxLength: 1000 - type: string - displayName: - description: Group name. - maxLength: 300 - minLength: 1 - type: string - externalId: - description: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. - type: string - type: - description: Group type. - enum: - - custom - - system - - external - type: string - x-ms-enum: - modelAsString: false - name: GroupType - required: - - displayName - "201": - description: The group was successfully associated with the product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Contract details. - properties: - properties: - description: Group contract Properties. - properties: - builtIn: - description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. - readOnly: true - type: boolean - description: - description: Group description. Can contain HTML formatting tags. - maxLength: 1000 - type: string - displayName: - description: Group name. - maxLength: 300 - minLength: 1 - type: string - externalId: - description: For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. - type: string - type: - description: Group type. - enum: - - custom - - system - - external - type: string - x-ms-enum: - modelAsString: false - name: GroupType - required: - - displayName - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductGroup - x-ms-examples: - ApiManagementCreateProductGroup: - parameters: - api-version: 2019-12-01-preview - groupId: templateGroup - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup - name: templateGroup - properties: - builtIn: false - description: group created via Template - displayName: Template Group - type: custom - type: Microsoft.ApiManagement/service/products/groups - "201": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/templateGroup - name: templateGroup - properties: - builtIn: false - description: group created via Template - displayName: Template Group - type: custom - type: Microsoft.ApiManagement/service/products/groups - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies": - get: - description: Get the policy configuration at the Product level. - operationId: ProductPolicy_ListByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product Policy information. - schema: - description: The response of the list policy operation. - properties: - nextLink: - description: Next page link if any. - type: string - value: - description: Policy Contract value. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Policy Contract details. - properties: - properties: - description: Policy contract Properties. - properties: - format: - default: xml - description: Format of the policyContent. - enum: - - xml - - xml-link - - rawxml - - rawxml-link - type: string - x-ms-enum: - modelAsString: true - name: PolicyContentFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The policy XML document is hosted on a http endpoint accessible from the API Management service. - value: xml-link - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - - description: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service. - value: rawxml-link - value: - description: Contents of the Policy as defined by the format. - type: string - required: - - value - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductPolicy - x-ms-examples: - ApiManagementListProductPolicies: - parameters: - api-version: 2019-12-01-preview - productId: armTemplateProduct4 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/armTemplateProduct4/policies/policy - name: policy - properties: - value: "\r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - " - type: Microsoft.ApiManagement/service/products/policies - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/policies/{policyId}": - delete: - description: Deletes the policy configuration at the Product. - operationId: ProductPolicy_Delete - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: The identifier of the Policy. - enum: - - policy - in: path - name: policyId - required: true - type: string - x-ms-enum: - modelAsString: true - name: PolicyIdName - x-ms-parameter-location: method - - description: ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. - in: header - name: If-Match - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Successfully deleted the policy configuration at the Product level. - "204": - description: Successfully deleted the policy configuration at the Product level. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductPolicy - x-ms-examples: - ApiManagementDeleteProductPolicy: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - policyId: policy - productId: testproduct - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": {} - "204": {} - get: - description: Get the policy configuration at the Product level. - operationId: ProductPolicy_Get - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: The identifier of the Policy. - enum: - - policy - in: path - name: policyId - required: true - type: string - x-ms-enum: - modelAsString: true - name: PolicyIdName - x-ms-parameter-location: method - - default: xml - description: Policy Export Format. - enum: - - xml - - rawxml - in: query - name: format - required: false - type: string - x-ms-enum: - modelAsString: true - name: PolicyExportFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product Policy information. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Policy Contract details. - properties: - properties: - description: Policy contract Properties. - properties: - format: - default: xml - description: Format of the policyContent. - enum: - - xml - - xml-link - - rawxml - - rawxml-link - type: string - x-ms-enum: - modelAsString: true - name: PolicyContentFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The policy XML document is hosted on a http endpoint accessible from the API Management service. - value: xml-link - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - - description: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service. - value: rawxml-link - value: - description: Contents of the Policy as defined by the format. - type: string - required: - - value - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductPolicy - x-ms-examples: - ApiManagementGetProductPolicy: - parameters: - api-version: 2019-12-01-preview - policyId: policy - productId: kjoshiarmTemplateProduct4 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/kjoshiarmTemplateProduct4/policies/policy - name: policy - properties: - value: "\r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - " - type: Microsoft.ApiManagement/service/products/policies - head: - description: Get the ETag of the policy configuration at the Product level. - operationId: ProductPolicy_GetEntityTag - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: The identifier of the Policy. - enum: - - policy - in: path - name: policyId - required: true - type: string - x-ms-enum: - modelAsString: true - name: PolicyIdName - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product Policy Etag information. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductPolicy - x-ms-examples: - ApiManagementHeadProductPolicy: - parameters: - api-version: 2019-12-01-preview - policyId: policy - productId: unlimited - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - headers: - etag: AAAAAAAAAAa= - put: - description: Creates or updates policy configuration for the Product. - operationId: ProductPolicy_CreateOrUpdate - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: The identifier of the Policy. - enum: - - policy - in: path - name: policyId - required: true - type: string - x-ms-enum: - modelAsString: true - name: PolicyIdName - x-ms-parameter-location: method - - description: ETag of the Entity. Not required when creating an entity, but required when updating an entity. - in: header - name: If-Match - required: false - type: string - x-ms-parameter-location: method - - description: The policy contents to apply. - in: body - name: parameters - required: true - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Policy Contract details. - properties: - properties: - description: Policy contract Properties. - properties: - format: - default: xml - description: Format of the policyContent. - enum: - - xml - - xml-link - - rawxml - - rawxml-link - type: string - x-ms-enum: - modelAsString: true - name: PolicyContentFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The policy XML document is hosted on a http endpoint accessible from the API Management service. - value: xml-link - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - - description: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service. - value: rawxml-link - value: - description: Contents of the Policy as defined by the format. - type: string - required: - - value - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Product policy configuration of the tenant was successfully updated. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Policy Contract details. - properties: - properties: - description: Policy contract Properties. - properties: - format: - default: xml - description: Format of the policyContent. - enum: - - xml - - xml-link - - rawxml - - rawxml-link - type: string - x-ms-enum: - modelAsString: true - name: PolicyContentFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The policy XML document is hosted on a http endpoint accessible from the API Management service. - value: xml-link - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - - description: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service. - value: rawxml-link - value: - description: Contents of the Policy as defined by the format. - type: string - required: - - value - "201": - description: Product policy configuration was successfully created. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Policy Contract details. - properties: - properties: - description: Policy contract Properties. - properties: - format: - default: xml - description: Format of the policyContent. - enum: - - xml - - xml-link - - rawxml - - rawxml-link - type: string - x-ms-enum: - modelAsString: true - name: PolicyContentFormat - values: - - description: The contents are inline and Content type is an XML document. - value: xml - - description: The policy XML document is hosted on a http endpoint accessible from the API Management service. - value: xml-link - - description: The contents are inline and Content type is a non XML encoded policy document. - value: rawxml - - description: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service. - value: rawxml-link - value: - description: Contents of the Policy as defined by the format. - type: string - required: - - value - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductPolicy - x-ms-examples: - ApiManagementCreateProductPolicy: - parameters: - api-version: 2019-12-01-preview - parameters: - properties: - format: xml - value: "\r - - \ \r - - \ \r - - \ \r - - \ @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - " - policyId: policy - productId: 5702e97e5157a50f48dce801 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy - name: policy - properties: - value: "\r - - \ \r - - \ \r - - \ \r - - \ @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - " - type: Microsoft.ApiManagement/service/products/policies - "201": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5702e97e5157a50f48dce801/policies/policy - name: policy - properties: - value: "\r - - \ \r - - \ \r - - \ \r - - \ @( string.Join(\",\", DateTime.UtcNow, context.Deployment.ServiceName, context.RequestId, context.Request.IpAddress, context.Operation.Name) ) \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - \ \r - - " - type: Microsoft.ApiManagement/service/products/policies - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions": - get: - description: Lists the collection of subscriptions to the specified product. - operationId: ProductSubscriptions_List - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filter | eq | |
| user | expand | | |
" - in: query - name: $filter - required: false - type: string - - description: Number of records to return. - format: int32 - in: query - minimum: 1 - name: $top - required: false - type: integer - x-ms-parameter-location: method - - description: Number of records to skip. - format: int32 - in: query - minimum: 0 - name: $skip - required: false - type: integer - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Lists a collection of subscription entities. - schema: - description: Paged Subscriptions list representation. - properties: - nextLink: - description: Next page link if any. - type: string - value: - description: Page values. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Subscription details. - properties: - properties: - description: Subscription details. - properties: - allowTracing: - description: Determines whether tracing is enabled - type: boolean - x-apim-code-nillable: true - createdDate: - description: | - Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. - format: date-time - readOnly: true - type: string - displayName: - description: The name of the subscription, or null if the subscription has no name. - maxLength: 100 - minLength: 0 - type: string - endDate: - description: | - Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. - format: date-time - type: string - expirationDate: - description: | - Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. - format: date-time - type: string - notificationDate: - description: | - Upcoming subscription expiration notification date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. - format: date-time - type: string - ownerId: - description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier. - type: string - primaryKey: - description: Subscription primary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. - maxLength: 256 - minLength: 1 - type: string - x-ms-secret: true - scope: - description: Scope like /products/{productId} or /apis or /apis/{apiId}. - type: string - secondaryKey: - description: Subscription secondary key. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value. - maxLength: 256 - minLength: 1 - type: string - x-ms-secret: true - startDate: - description: | - Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. - format: date-time - type: string - state: - description: Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. - enum: - - suspended - - active - - expired - - submitted - - rejected - - cancelled - type: string - x-ms-enum: - modelAsString: false - name: SubscriptionState - stateComment: - description: Optional subscription comment added by an administrator. - type: string - required: - - scope - - state - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductSubscription - x-ms-examples: - ApiManagementListProductSubscriptions: - parameters: - api-version: 2019-12-01-preview - productId: 5600b57e7e8880006a060002 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002/subscriptions/5600b57e7e8880006a070002 - name: 5600b57e7e8880006a070002 - properties: - createdDate: 2015-09-22T01:57:18.723Z - ownerId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1 - scope: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b57e7e8880006a060002 - state: active - type: Microsoft.ApiManagement/service/products/subscriptions - x-ms-odata: ./definitions.json#/definitions/SubscriptionContract - x-ms-pageable: - nextLinkName: nextLink - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags": - get: - description: Lists all Tags associated with the Product. - operationId: Tag_ListByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: "| Field | Usage | Supported operators | Supported functions |
|-------------|-------------|-------------|-------------|
| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
" - in: query - name: $filter - required: false - type: string - - description: Number of records to return. - format: int32 - in: query - minimum: 1 - name: $top - required: false - type: integer - x-ms-parameter-location: method - - description: Number of records to skip. - format: int32 - in: query - minimum: 0 - name: $skip - required: false - type: integer - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: The operation returns a collection of tags associated with the Product entity. - schema: - description: Paged Tag list representation. - properties: - nextLink: - description: Next page link if any. - type: string - value: - description: Page values. - items: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Tag Contract details. - properties: - properties: - description: Tag contract Properties. - properties: - displayName: - description: Tag name. - maxLength: 160 - minLength: 1 - type: string - required: - - displayName - type: array - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductTag - x-ms-examples: - ApiManagementListProductTags: - parameters: - api-version: 2019-12-01-preview - productId: 57d2ef278aa04f0888cba3f1 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - responses: - "200": - body: - nextLink: "" - value: - - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002 - name: 5600b539c53f5b0062060002 - properties: - displayName: tag1 - type: Microsoft.ApiManagement/service/tags - x-ms-odata: ./definitions.json#/definitions/TagContract - x-ms-pageable: - nextLinkName: nextLink - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}": - delete: - description: Detach the tag from the Product. - operationId: Tag_DetachFromProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Tag identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 80 - minLength: 1 - name: tagId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Successfully detached the tag from the Product. - "204": - description: Successfully detached the tag from the Product. - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductTag - x-ms-examples: - ApiManagementDeleteProductTag: - parameters: - If-Match: "*" - api-version: 2019-12-01-preview - productId: 59d5b28d1f7fab116c282650 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - tagId: 59d5b28e1f7fab116402044e - responses: - "200": {} - "204": {} - get: - description: Get tag associated with the Product. - operationId: Tag_GetByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Tag identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 80 - minLength: 1 - name: tagId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Gets the details of the tag specified by its identifier. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Tag Contract details. - properties: - properties: - description: Tag contract Properties. - properties: - displayName: - description: Tag name. - maxLength: 160 - minLength: 1 - type: string - required: - - displayName - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductTag - x-ms-examples: - ApiManagementGetProductTag: - parameters: - api-version: 2019-12-01-preview - productId: 59d6bb8f1f7fab13dc67ec9b - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - tagId: 59306a29e4bbd510dc24e5f9 - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/59306a29e4bbd510dc24e5f9 - name: 59306a29e4bbd510dc24e5f9 - properties: - displayName: tag1 - type: Microsoft.ApiManagement/service/tags - head: - description: Gets the entity state version of the tag specified by its identifier. - operationId: Tag_GetEntityStateByProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Tag identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 80 - minLength: 1 - name: tagId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Empty response body, ETag header entity state version. - headers: - ETag: - description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. - type: string - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductTag - x-ms-examples: - ApiManagementHeadProductTag: - parameters: - api-version: 2019-12-01-preview - productId: 59306a29e4bbd510dc24e5f8 - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - tagId: 59306a29e4bbd510dc24e5f9 - responses: - "200": - headers: - Etag: AAAAAAAACCI= - put: - description: Assign tag to the Product. - operationId: Tag_AssignToProduct - parameters: - - description: The name of the resource group. - in: path - name: resourceGroupName - required: true - type: string - x-ms-parameter-location: method - - description: The name of the API Management service. - in: path - maxLength: 50 - minLength: 1 - name: serviceName - pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ - required: true - type: string - x-ms-parameter-location: method - - description: Product identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 256 - minLength: 1 - name: productId - required: true - type: string - x-ms-parameter-location: method - - description: Tag identifier. Must be unique in the current API Management service instance. - in: path - maxLength: 80 - minLength: 1 - name: tagId - pattern: ^[^*#&+:<>?]+$ - required: true - type: string - x-ms-parameter-location: method - - description: Version of the API to be used with the client request. - in: query - name: api-version - required: true - type: string - - description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - in: path - name: subscriptionId - required: true - type: string - responses: - "200": - description: Tag is already assigned to the Product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Tag Contract details. - properties: - properties: - description: Tag contract Properties. - properties: - displayName: - description: Tag name. - maxLength: 160 - minLength: 1 - type: string - required: - - displayName - "201": - description: Tag was assigned to the Product. - schema: - allOf: - - description: The Resource definition. - properties: - id: - description: Resource ID. - readOnly: true - type: string - name: - description: Resource name. - readOnly: true - type: string - type: - description: Resource type for API Management resource. - readOnly: true - type: string - x-ms-azure-resource: true - description: Tag Contract details. - properties: - properties: - description: Tag contract Properties. - properties: - displayName: - description: Tag name. - maxLength: 160 - minLength: 1 - type: string - required: - - displayName - default: - description: Error response describing why the operation failed. - schema: - description: Error Response. - properties: - error: - description: Error Body contract. - properties: - code: - description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. - type: string - details: - description: The list of invalid fields send in request, in case of validation error. - items: - description: Error Field contract. - properties: - code: - description: Property level error code. - type: string - message: - description: Human-readable representation of property-level error. - type: string - target: - description: Property name. - type: string - type: array - message: - description: Human-readable representation of the error. - type: string - tags: - - ProductTag - x-ms-examples: - ApiManagementCreateProductTag: - parameters: - api-version: 2019-12-01-preview - productId: 5931a75ae4bbd512a88c680b - resourceGroupName: rg1 - serviceName: apimService1 - subscriptionId: subid - tagId: tagId1 - responses: - "200": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1 - name: tagId1 - properties: - displayName: tag1 - type: Microsoft.ApiManagement/service/tags - "201": - body: - id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1 - name: tagId1 - properties: - displayName: tag1 - type: Microsoft.ApiManagement/service/tags -definitions: {} diff --git a/packages/openapi-parser/tests/files/chaingatewayio.yaml b/packages/openapi-parser/tests/files/chaingatewayio.yaml deleted file mode 100644 index 5f45425..0000000 --- a/packages/openapi-parser/tests/files/chaingatewayio.yaml +++ /dev/null @@ -1,1886 +0,0 @@ -openapi: 3.0.0 -servers: - - url: https://eu.eth.chaingateway.io/v1 - variables: {} -info: - contact: {} - description: |- - # Chaingateway.io - - REST API to build the bridge between Ethereum and the real world - - Please check out our [website](https://chaingateway.io?utm_source=postman) for detailed information about this API. - - To use our API, you need an API Key (Described as Authorization header in the examples below). - To get one, please create an account on our [website](https://chaingateway.io/register?utm_source=postman). - - For our internal documentation, please check out our [Docs Site](https://chaingateway.io/docs?utm_source=postman). - - If you need help with integrating our API in your application, you can reach us via [email](mailto:support@chaingateway.io) or join our official [Telegram](https://t.me/chaingateway) group. - title: Chaingateway.io - version: "1.0" - x-apisguru-categories: - - financial - x-origin: - - format: openapi - url: https://chaingateway.io/downloads/openapiv3.json - version: "3.0" - x-providerName: chaingateway.io - x-logo: - url: https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg -tags: - - description: Requests that return information on balances, transactions, gas price, exchange rates, ... - name: Info Requests - - description: Requests to create, list and delete addresses - name: Address Requests - - description: Requests for creating, deleting and listing existing subscriptions - name: Subscription/IPN Requests - - description: Requests to send Tokens, Ethereum and clear addresses - name: Transaction Requests -paths: - /clearAddress: - post: - deprecated: false - description: Sends all available ethereum funds of an address to a specified receiver address. - operationId: clearAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - ethereumaddress: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - newaddress: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/clearAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - amount: 0.02300916225 - ethereumaddress: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - gas: 0.0025199999999999997 - newaddress: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - ok: true - total: "0.025529162250000000" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - schema: - $ref: "#/components/schemas/clearAddress" - description: "" - headers: {} - security: [] - summary: clearAddress - tags: - - Transaction Requests - /deleteAddress: - post: - deprecated: false - description: Deletes an existing ethereum address. Be careful when using this function. - operationId: deleteAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - ethereumaddress: "0x71892689ed0d79d88ab6ea3783b571b8ece9bee3" - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/deleteAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - deleted: true - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - schema: - $ref: "#/components/schemas/deleteAddress" - description: "" - headers: {} - security: [] - summary: deleteAddress - tags: - - Address Requests - /exportAddress: - post: - deprecated: false - description: Returns all ethereum addresses created with an account. - operationId: exportAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - ethaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/exportAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - content: "{'version':3,'id':'85b790ff-408e-42b8-b123-bec9523964dc','address':'71892889ed4d79d88ab6ea3783b571b8ece9bef4','crypto':{'ciphertext':'9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f','cipherparams':{'iv':'76e6f2497b9f2a8e024fc752a5418a6d'},'cipher':'aes-128-ctr','kdf':'scrypt','kdfparams':{'dklen':32,'salt':'d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4','n':131072,'r':8,'p':1},'mac':'dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9'}}" - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - ok: true - schema: - $ref: "#/components/schemas/exportAddress" - description: "" - headers: {} - security: [] - summary: exportAddress - tags: - - Address Requests - /getBlock: - post: - deprecated: false - description: Returns information of an ethereum block with or without transactions - operationId: getBlock - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - block: "5000000" - schema: - $ref: "#/components/schemas/getBlockRequest" - required: true - responses: - "200": - content: - application/json: - example: - block_number: "5000000" - difficulty: "2546613975853490" - gas_limit: "8000029" - gas_used: "7994053" - hash: "0x7d5a4369273c723454ac137f48a4f142b097aa2779464e6505f1b1c5e37b5382" - miner: "0xb2930B35844a230f00E51431aCAe96Fe543a0347" - ok: true - parent_hash: "0xcae4df80f5862e4321690857eded0d8a40136dafb8155453920bade5bd0c46c0" - size_in_bytes: "24017" - time_stamp: 2018-01-30 14:41:33 - transactions_count: "109" - schema: - $ref: "#/components/schemas/getBlock" - description: "" - headers: {} - security: [] - summary: getBlock - tags: - - Info Requests - /getEthereumBalance: - post: - deprecated: false - description: Returns the ethereum balance of a given address. - operationId: getEthereumBalance - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - schema: - $ref: "#/components/schemas/getEthereumBalanceRequest" - required: true - responses: - "200": - content: - application/json: - example: - balance: 0.009956019840987648 - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - ok: true - schema: - $ref: "#/components/schemas/getEthereumBalance" - description: "" - headers: {} - security: [] - summary: getEthereumBalance - tags: - - Info Requests - /getExchangeRate: - post: - deprecated: false - description: Returns the current Ethereum price in Euro or US Dollar. - operationId: getExchangeRate - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - currency: eur - schema: - $ref: "#/components/schemas/getExchangeRateRequest" - required: true - responses: - "200": - content: - application/json: - example: - currency: eur - ok: true - rate: 321.2 - schema: - $ref: "#/components/schemas/getExchangeRate" - description: "" - headers: {} - security: [] - summary: getExchangeRate - tags: - - Info Requests - /getGasPrice: - post: - deprecated: false - description: Returns the current gas price in GWEI. - operationId: getGasPrice - parameters: - - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string - style: simple - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - responses: - "200": - content: - application/json: - example: - gasprice: 70 - ok: true - schema: - $ref: "#/components/schemas/getGasPrice" - description: "" - headers: {} - security: [] - summary: getGasPrice - tags: - - Info Requests - /getLastBlockNumber: - post: - deprecated: false - description: Returns the block number of the last mined ethereum block. - operationId: getLastBlockNumber - parameters: - - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string - style: simple - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - responses: - "200": - content: - application/json: - example: - blocknumber: 10892021 - ok: true - schema: - $ref: "#/components/schemas/getLastBlockNumber" - description: "" - headers: {} - security: [] - summary: getLastBlockNumber - tags: - - Info Requests - /getToken: - post: - deprecated: false - description: Returns information about a specific ERC20 token like name, symbol, decimal places and total supply. - operationId: getToken - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - schema: - $ref: "#/components/schemas/getTokenRequest" - required: true - responses: - "200": - content: - application/json: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - decimals: 2 - name: Bitfranken - ok: true - supply: 76507131570 - symbol: BIFRA - schema: - $ref: "#/components/schemas/getToken" - description: "" - headers: {} - security: [] - summary: getToken - tags: - - Info Requests - /getTokenBalance: - post: - deprecated: false - description: Returns the token balance of a given address. - operationId: getTokenBalance - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - schema: - $ref: "#/components/schemas/getTokenBalanceRequest" - required: true - responses: - "200": - content: - application/json: - example: - balance: 9980 - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - ok: true - schema: - $ref: "#/components/schemas/getTokenBalance" - description: "" - headers: {} - security: [] - summary: getTokenBalance - tags: - - Info Requests - /getTransactions: - post: - deprecated: false - description: Returns information like confirmations, token contract address, amount, gas price and more of a given transaction. - operationId: getTransactions - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - txid: "0x8ab5543bc103bdd908681da501d03c2c495afd7fde5ed104935ba97b1550d65b" - schema: - $ref: "#/components/schemas/getTransactionsRequest" - required: true - responses: - "200": - content: - application/json: - example: - ok: true - transactions: - - amount: "10" - block_number: "6432816" - contract_address: "0x9E2B71e87d9304c4773674584EB9D0c838643568" - from: "0x8dF9654c7D81c850FDd35D93292B2fC60e666bF0" - gas: "90000" - gas_price: "9" - to: "0xbee9422f1b65687d0cb923bbd1fc5ccb9307e861" - token_decimals: "18" - token_name: Shopiblock - token_supply: "1000000000" - token_symbol: SHB - txid: "0x8ab5543bc103bdd908681da501d03c2c495afd7fde5ed104935ba97b1550d65b" - type: ERC20 - schema: - $ref: "#/components/schemas/getTransactions" - description: "" - headers: {} - security: [] - summary: getTransactions - tags: - - Info Requests - /importAddress: - post: - deprecated: false - description: Returns all ethereum addresses created with an account. - operationId: importAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - content: - address: 71892889ed4d79d88ab6ea3783b571b8ece9bef4 - crypto: - cipher: aes-128-ctr - cipherparams: - iv: 76e6f2497b9f2a8e024fc752a5418a6d - ciphertext: 9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f - kdf: scrypt - kdfparams: - dklen: 32 - n: 131072 - p: 1 - r: 8 - salt: d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4 - mac: dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9 - id: 85b790ff-408e-42b8-b123-bec9523964dc - version: 3 - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/importAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - ethaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - ok: true - schema: - $ref: "#/components/schemas/importAddress" - description: "" - headers: {} - security: [] - summary: importAddress - tags: - - Address Requests - /listAddresses: - post: - deprecated: false - description: Returns all ethereum addresses created with an account. - operationId: listAddresses - parameters: - - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string - style: simple - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - responses: - "200": - content: - application/json: - example: - addresses: - - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - schema: - $ref: "#/components/schemas/listAddresses" - description: "" - headers: {} - security: [] - summary: listAddresses - tags: - - Address Requests - /listFailedIPNs: - post: - deprecated: false - description: Returns all subscriptions/IPNs created with an account. - operationId: listFailedIPNs - parameters: - - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string - style: simple - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - responses: - "200": - content: - application/json: - example: - failed_ipns: - - action: deposit - amount: "496588.7771277759" - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - id: "17766" - timestamp: 2020-09-19 14:33:01 - url: https://yoururl.com/ipnreceiver.php - ok: true - schema: - $ref: "#/components/schemas/listFailedIPNs" - description: "" - headers: {} - security: [] - summary: listFailedIPNs - tags: - - Subscription/IPN Requests - /listSubscribedAddresses: - post: - deprecated: false - description: Returns all subscriptions/IPNs created with an account. - operationId: listSubscribedAddresses - parameters: - - in: header - name: Content-Type - required: true - schema: - example: application/json - type: string - style: simple - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - responses: - "200": - content: - application/json: - example: - ipns: - - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - ok: true - schema: - $ref: "#/components/schemas/listSubscribedAddresses" - description: "" - headers: {} - security: [] - summary: listSubscribedAddresses - tags: - - Subscription/IPN Requests - /newAddress: - post: - deprecated: false - description: Generates a new ethereum addresses you can use to send or receive funds. Do not lose the password! We can't restore access to an address if you lose it. - operationId: newAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/newAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - password: padN39QkRA2hJ - schema: - $ref: "#/components/schemas/newAddress" - description: "" - headers: {} - security: [] - summary: newAddress - tags: - - Address Requests - /resendFailedIPN: - post: - deprecated: false - description: Returns all subscriptions/IPNs created with an account. - operationId: resendFailedIPN - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - id: 17766 - schema: - $ref: "#/components/schemas/resendFailedIPNRequest" - required: true - responses: - "200": - content: - application/json: - example: - id: 17766 - ok: true - schema: - $ref: "#/components/schemas/resendFailedIPN" - description: "" - headers: {} - security: [] - summary: resendFailedIPN - tags: - - Subscription/IPN Requests - /sendEthereum: - post: - deprecated: false - description: Sends ethereum from an address controlled by the account to a specified receiver address. - operationId: sendEthereum - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - amount: 0.01 - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - password: padN39QkRA2hJ - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - schema: - $ref: "#/components/schemas/sendEthereumRequest" - required: true - responses: - "200": - content: - application/json: - example: - amount: "0.010000000000000000" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - ok: true - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - schema: - $ref: "#/components/schemas/sendEthereum" - description: "" - headers: {} - security: [] - summary: sendEthereum - tags: - - Transaction Requests - /sendToken: - post: - deprecated: false - description: Sends ERC20 tokens from an address controlled by the account to a specified receiver address. The token contract address is needed to specify the token. The use of the identifier parameter is recommend and awaits an unique string. Whenever a transaction is beeing sent, the identifier is checked and the transaction gets dropped if there is one with that identifier already. - operationId: sendToken - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - amount: 5 - contractaddress: "0xdac17f958d2ee523a2206206994597c13d831ec7" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - identifier: CN562 - password: padN39QkRA2hJ - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - schema: - $ref: "#/components/schemas/sendTokenRequest" - required: true - responses: - "200": - content: - application/json: - example: - amount: 5 - contractaddress: "0xdac17f958d2ee523a2206206994597c13d831ec7" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - identifier: CN562 - ok: true - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - schema: - $ref: "#/components/schemas/sendToken" - description: "" - headers: {} - security: [] - summary: sendToken - tags: - - Transaction Requests - /subscribeAddress: - post: - deprecated: false - description: "Creates a new subscription/IPN for the given address (and contractaddress). You will receive a notification to the given url every time a deposit is received. Unsubscribe the address before sending tokens/ETH from it or you won't get reliable notifications anymore.\r\n" - operationId: subscribeAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - schema: - $ref: "#/components/schemas/subscribeAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - ok: true - url: https://yoururl.com/ipnreceiver.php - schema: - $ref: "#/components/schemas/subscribeAddress" - description: "" - headers: {} - security: [] - summary: subscribeAddress - tags: - - Subscription/IPN Requests - /unsubscribeAddress: - post: - deprecated: false - description: Deletes an existing subscription/IPN for the given address (and contractaddress). - operationId: unsubscribeAddress - parameters: - - description: API Key - in: header - name: Authorization - required: true - schema: - example: q9PdaWuD4j6DK6vsUgehhL8pgarSrS9m - type: string - style: simple - requestBody: - content: - application/json: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - schema: - $ref: "#/components/schemas/unsubscribeAddressRequest" - required: true - responses: - "200": - content: - application/json: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - deleted: true - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - ok: true - url: https://yoururl.com/ipnreceiver.php - schema: - $ref: "#/components/schemas/unsubscribeAddress" - description: "" - headers: {} - security: [] - summary: unsubscribeAddress - tags: - - Subscription/IPN Requests -components: - schemas: - Address: - example: - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - properties: - ethereumaddress: - type: string - required: - - ethereumaddress - title: Address - type: object - Cipherparams: - example: - iv: 76e6f2497b9f2a8e024fc752a5418a6d - properties: - iv: - type: string - required: - - iv - title: Cipherparams - type: object - Content: - example: - address: 71892889ed4d79d88ab6ea3783b571b8ece9bef4 - crypto: - cipher: aes-128-ctr - cipherparams: - iv: 76e6f2497b9f2a8e024fc752a5418a6d - ciphertext: 9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f - kdf: scrypt - kdfparams: - dklen: 32 - n: 131072 - p: 1 - r: 8 - salt: d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4 - mac: dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9 - id: 85b790ff-408e-42b8-b123-bec9523964dc - version: 3 - properties: - address: - type: string - crypto: - $ref: "#/components/schemas/Crypto" - id: - type: string - version: - format: int32 - type: integer - required: - - version - - id - - address - - crypto - title: Content - type: object - Crypto: - example: - cipher: aes-128-ctr - cipherparams: - iv: 76e6f2497b9f2a8e024fc752a5418a6d - ciphertext: 9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f - kdf: scrypt - kdfparams: - dklen: 32 - n: 131072 - p: 1 - r: 8 - salt: d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4 - mac: dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9 - properties: - cipher: - type: string - cipherparams: - $ref: "#/components/schemas/Cipherparams" - ciphertext: - type: string - kdf: - type: string - kdfparams: - $ref: "#/components/schemas/Kdfparams" - mac: - type: string - required: - - ciphertext - - cipherparams - - cipher - - kdf - - kdfparams - - mac - title: Crypto - type: object - FailedIpn: - example: - action: deposit - amount: "496588.7771277759" - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - id: "17766" - timestamp: 2020-09-19 14:33:01 - url: https://yoururl.com/ipnreceiver.php - properties: - action: - type: string - amount: - type: string - contractaddress: - type: string - ethereumaddress: - type: string - id: - type: string - timestamp: - type: string - url: - type: string - required: - - id - - timestamp - - ethereumaddress - - contractaddress - - amount - - url - - action - title: FailedIpn - type: object - Ipn: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - properties: - contractaddress: - type: string - ethereumaddress: - type: string - url: - type: string - required: - - ethereumaddress - - contractaddress - - url - title: Ipn - type: object - Kdfparams: - example: - dklen: 32 - n: 131072 - p: 1 - r: 8 - salt: d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4 - properties: - dklen: - format: int32 - type: integer - n: - format: int32 - type: integer - p: - format: int32 - type: integer - r: - format: int32 - type: integer - salt: - type: string - required: - - dklen - - salt - - n - - r - - p - title: Kdfparams - type: object - Transaction: - example: - amount: "10" - block_number: "6432816" - contract_address: "0x9E2B71e87d9304c4773674584EB9D0c838643568" - from: "0x8dF9654c7D81c850FDd35D93292B2fC60e666bF0" - gas: "90000" - gas_price: "9" - to: "0xbee9422f1b65687d0cb923bbd1fc5ccb9307e861" - token_decimals: "18" - token_name: Shopiblock - token_supply: "1000000000" - token_symbol: SHB - txid: "0x8ab5543bc103bdd908681da501d03c2c495afd7fde5ed104935ba97b1550d65b" - type: ERC20 - properties: - amount: - type: string - block_number: - type: string - contract_address: - type: string - from: - type: string - gas: - type: string - gas_price: - type: string - to: - type: string - token_decimals: - type: string - token_name: - type: string - token_supply: - type: string - token_symbol: - type: string - txid: - type: string - type: - type: string - required: - - txid - - block_number - - contract_address - - type - - token_name - - token_symbol - - token_decimals - - token_supply - - gas - - gas_price - - from - - to - - amount - title: Transaction - type: object - clearAddress: - example: - amount: 0.02300916225 - ethereumaddress: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - gas: 0.0025199999999999997 - newaddress: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - ok: true - total: "0.025529162250000000" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - properties: - amount: - type: number - ethereumaddress: - type: string - gas: - type: number - newaddress: - type: string - ok: - type: boolean - total: - type: string - txid: - type: string - required: - - ok - - txid - - ethereumaddress - - newaddress - - amount - - gas - - total - title: clearAddress - type: object - clearAddressRequest: - example: - ethereumaddress: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - newaddress: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - password: padN39QkRA2hJ - properties: - ethereumaddress: - type: string - newaddress: - type: string - password: - type: string - required: - - ethereumaddress - - newaddress - - password - title: clearAddressRequest - type: object - deleteAddress: - example: - deleted: true - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - properties: - deleted: - type: boolean - ethereumaddress: - type: string - ok: - type: boolean - required: - - ok - - ethereumaddress - - deleted - title: deleteAddress - type: object - deleteAddressRequest: - example: - ethereumaddress: "0x71892689ed0d79d88ab6ea3783b571b8ece9bee3" - password: padN39QkRA2hJ - properties: - ethereumaddress: - type: string - password: - type: string - required: - - ethereumaddress - - password - title: deleteAddressRequest - type: object - exportAddress: - example: - content: "{'version':3,'id':'85b790ff-408e-42b8-b123-bec9523964dc','address':'71892889ed4d79d88ab6ea3783b571b8ece9bef4','crypto':{'ciphertext':'9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f','cipherparams':{'iv':'76e6f2497b9f2a8e024fc752a5418a6d'},'cipher':'aes-128-ctr','kdf':'scrypt','kdfparams':{'dklen':32,'salt':'d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4','n':131072,'r':8,'p':1},'mac':'dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9'}}" - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - ok: true - properties: - content: - type: string - filename: - type: string - ok: - type: boolean - required: - - ok - - filename - - content - title: exportAddress - type: object - exportAddressRequest: - example: - ethaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - password: padN39QkRA2hJ - properties: - ethaddress: - type: string - password: - type: string - required: - - ethaddress - - password - title: exportAddressRequest - type: object - getBlock: - example: - block_number: "5000000" - difficulty: "2546613975853490" - gas_limit: "8000029" - gas_used: "7994053" - hash: "0x7d5a4369273c723454ac137f48a4f142b097aa2779464e6505f1b1c5e37b5382" - miner: "0xb2930B35844a230f00E51431aCAe96Fe543a0347" - ok: true - parent_hash: "0xcae4df80f5862e4321690857eded0d8a40136dafb8155453920bade5bd0c46c0" - size_in_bytes: "24017" - time_stamp: 2018-01-30 14:41:33 - transactions_count: "109" - properties: - block_number: - type: string - difficulty: - type: string - gas_limit: - type: string - gas_used: - type: string - hash: - type: string - miner: - type: string - ok: - type: boolean - parent_hash: - type: string - size_in_bytes: - type: string - time_stamp: - type: string - transactions_count: - type: string - required: - - ok - - hash - - block_number - - parent_hash - - miner - - difficulty - - size_in_bytes - - gas_limit - - gas_used - - time_stamp - - transactions_count - title: getBlock - type: object - getBlockRequest: - example: - block: "5000000" - properties: - block: - type: string - required: - - block - title: getBlockRequest - type: object - getEthereumBalance: - example: - balance: 0.009956019840987648 - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - ok: true - properties: - balance: - type: number - ethereumaddress: - type: string - ok: - type: boolean - required: - - ok - - ethereumaddress - - balance - title: getEthereumBalance - type: object - getEthereumBalanceRequest: - example: - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - properties: - ethereumaddress: - type: string - required: - - ethereumaddress - title: getEthereumBalanceRequest - type: object - getExchangeRate: - example: - currency: eur - ok: true - rate: 321.2 - properties: - currency: - type: string - ok: - type: boolean - rate: - type: number - required: - - ok - - currency - - rate - title: getExchangeRate - type: object - getExchangeRateRequest: - example: - currency: eur - properties: - currency: - type: string - required: - - currency - title: getExchangeRateRequest - type: object - getGasPrice: - example: - gasprice: 70 - ok: true - properties: - gasprice: - format: int32 - type: integer - ok: - type: boolean - required: - - ok - - gasprice - title: getGasPrice - type: object - getLastBlockNumber: - example: - blocknumber: 10892021 - ok: true - properties: - blocknumber: - format: int32 - type: integer - ok: - type: boolean - required: - - ok - - blocknumber - title: getLastBlockNumber - type: object - getToken: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - decimals: 2 - name: Bitfranken - ok: true - supply: 76507131570 - symbol: BIFRA - properties: - contractaddress: - type: string - decimals: - format: int32 - type: integer - name: - type: string - ok: - type: boolean - supply: - format: int64 - type: integer - symbol: - type: string - required: - - ok - - contractaddress - - name - - symbol - - decimals - - supply - title: getToken - type: object - getTokenBalance: - example: - balance: 9980 - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - ok: true - properties: - balance: - format: int32 - type: integer - contractaddress: - type: string - ethereumaddress: - type: string - ok: - type: boolean - required: - - ok - - contractaddress - - ethereumaddress - - balance - title: getTokenBalance - type: object - getTokenBalanceRequest: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - ethereumaddress: "0xa1f36016221d48ce7f15cde7b826a4fbe09bacce" - properties: - contractaddress: - type: string - ethereumaddress: - type: string - required: - - contractaddress - - ethereumaddress - title: getTokenBalanceRequest - type: object - getTokenRequest: - example: - contractaddress: "0x5b86a33f0c232fe909eb4602a9d039072869d915" - properties: - contractaddress: - type: string - required: - - contractaddress - title: getTokenRequest - type: object - getTransactions: - example: - ok: true - transactions: - - amount: "10" - block_number: "6432816" - contract_address: "0x9E2B71e87d9304c4773674584EB9D0c838643568" - from: "0x8dF9654c7D81c850FDd35D93292B2fC60e666bF0" - gas: "90000" - gas_price: "9" - to: "0xbee9422f1b65687d0cb923bbd1fc5ccb9307e861" - token_decimals: "18" - token_name: Shopiblock - token_supply: "1000000000" - token_symbol: SHB - txid: "0x8ab5543bc103bdd908681da501d03c2c495afd7fde5ed104935ba97b1550d65b" - type: ERC20 - properties: - ok: - type: boolean - transactions: - items: - $ref: "#/components/schemas/Transaction" - type: array - required: - - ok - - transactions - title: getTransactions - type: object - getTransactionsRequest: - example: - txid: "0x8ab5543bc103bdd908681da501d03c2c495afd7fde5ed104935ba97b1550d65b" - properties: - txid: - type: string - required: - - txid - title: getTransactionsRequest - type: object - importAddress: - example: - ethaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - ok: true - properties: - ethaddress: - type: string - filename: - type: string - ok: - type: boolean - required: - - ok - - ethaddress - - filename - title: importAddress - type: object - importAddressRequest: - example: - content: - address: 71892889ed4d79d88ab6ea3783b571b8ece9bef4 - crypto: - cipher: aes-128-ctr - cipherparams: - iv: 76e6f2497b9f2a8e024fc752a5418a6d - ciphertext: 9d74262517b984f9b0560b8f23b5e3340f7be0f56b70cd91ff445dcaf5b1968f - kdf: scrypt - kdfparams: - dklen: 32 - n: 131072 - p: 1 - r: 8 - salt: d11d996a7cc4bfad730d4c9b9057eff2c0fb3940b5bfc59db62ae218c14a54f4 - mac: dcc342bbbbb8eea97c89b47bafc23de568fc1a48e0bd21ae8d776a95c4704ac9 - id: 85b790ff-408e-42b8-b123-bec9523964dc - version: 3 - filename: UTC--2020-09-19T10-42-26.196Z--71892889ed4d79d88ab6ea3783b571b8ece9bef4 - password: padN39QkRA2hJ - properties: - content: - $ref: "#/components/schemas/Content" - filename: - type: string - password: - type: string - required: - - filename - - content - - password - title: importAddressRequest - type: object - listAddresses: - example: - addresses: - - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - properties: - addresses: - items: - $ref: "#/components/schemas/Address" - type: array - ok: - type: boolean - required: - - ok - - addresses - title: listAddresses - type: object - listFailedIPNs: - example: - failed_ipns: - - action: deposit - amount: "496588.7771277759" - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - id: "17766" - timestamp: 2020-09-19 14:33:01 - url: https://yoururl.com/ipnreceiver.php - ok: true - properties: - failed_ipns: - items: - $ref: "#/components/schemas/FailedIpn" - type: array - ok: - type: boolean - required: - - ok - - failed_ipns - title: listFailedIPNs - type: object - listSubscribedAddresses: - example: - ipns: - - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - ok: true - properties: - ipns: - items: - $ref: "#/components/schemas/Ipn" - type: array - ok: - type: boolean - required: - - ok - - ipns - title: listSubscribedAddresses - type: object - newAddress: - example: - ethereumaddress: "0x71892889ed4d79d88ab6ea3783b571b8ece9bef4" - ok: true - password: padN39QkRA2hJ - properties: - ethereumaddress: - type: string - ok: - type: boolean - password: - type: string - required: - - ok - - ethereumaddress - - password - title: newAddress - type: object - newAddressRequest: - example: - password: padN39QkRA2hJ - properties: - password: - type: string - required: - - password - title: newAddressRequest - type: object - resendFailedIPN: - example: - id: 17766 - ok: true - properties: - id: - format: int32 - type: integer - ok: - type: boolean - required: - - ok - - id - title: resendFailedIPN - type: object - resendFailedIPNRequest: - example: - id: 17766 - properties: - id: - format: int32 - type: integer - required: - - id - title: resendFailedIPNRequest - type: object - sendEthereum: - example: - amount: "0.010000000000000000" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - ok: true - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - properties: - amount: - type: string - from: - type: string - ok: - type: boolean - to: - type: string - txid: - type: string - required: - - ok - - txid - - from - - to - - amount - title: sendEthereum - type: object - sendEthereumRequest: - example: - amount: 0.01 - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - password: padN39QkRA2hJ - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - properties: - amount: - type: number - from: - type: string - password: - type: string - to: - type: string - required: - - from - - to - - password - - amount - title: sendEthereumRequest - type: object - sendToken: - example: - amount: 5 - contractaddress: "0xdac17f958d2ee523a2206206994597c13d831ec7" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - identifier: CN562 - ok: true - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - txid: "0xcff06775098019d18f7bab6a350c18e86f89399db63cbce5269104e6c9a79499" - properties: - amount: - format: int32 - type: integer - contractaddress: - type: string - from: - type: string - identifier: - type: string - ok: - type: boolean - to: - type: string - txid: - type: string - required: - - ok - - identifier - - txid - - contractaddress - - from - - to - - amount - title: sendToken - type: object - sendTokenRequest: - example: - amount: 5 - contractaddress: "0xdac17f958d2ee523a2206206994597c13d831ec7" - from: "0x3a32c4c31fe8d2a89976af5d284a94a040b44aa8" - identifier: CN562 - password: padN39QkRA2hJ - to: "0xef4943d727e34280a2efa0b3352dfd61f508ee48" - properties: - amount: - format: int32 - type: integer - contractaddress: - type: string - from: - type: string - identifier: - type: string - password: - type: string - to: - type: string - required: - - contractaddress - - from - - to - - password - - amount - - identifier - title: sendTokenRequest - type: object - subscribeAddress: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - ok: true - url: https://yoururl.com/ipnreceiver.php - properties: - contractaddress: - type: string - ethereumaddress: - type: string - ok: - type: boolean - url: - type: string - required: - - ok - - ethereumaddress - - contractaddress - - url - title: subscribeAddress - type: object - subscribeAddressRequest: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - properties: - contractaddress: - type: string - ethereumaddress: - type: string - url: - type: string - required: - - ethereumaddress - - contractaddress - - url - title: subscribeAddressRequest - type: object - unsubscribeAddress: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - deleted: true - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - ok: true - url: https://yoururl.com/ipnreceiver.php - properties: - contractaddress: - type: string - deleted: - type: boolean - ethereumaddress: - type: string - ok: - type: boolean - url: - type: string - required: - - ok - - ethereumaddress - - contractaddress - - url - - deleted - title: unsubscribeAddress - type: object - unsubscribeAddressRequest: - example: - contractaddress: "0x514910771af9ca656af840dff83e8264ecf986ca" - ethereumaddress: "0xa2107fa5b38d9bbd2c461d6edf11b11a50f6b974" - url: https://yoururl.com/ipnreceiver.php - properties: - contractaddress: - type: string - ethereumaddress: - type: string - url: - type: string - required: - - ethereumaddress - - contractaddress - - url - title: unsubscribeAddressRequest - type: object diff --git a/packages/openapi-parser/tests/files/vmwarelocalvrni.yaml b/packages/openapi-parser/tests/files/vmwarelocalvrni.yaml deleted file mode 100644 index 8d03132..0000000 --- a/packages/openapi-parser/tests/files/vmwarelocalvrni.yaml +++ /dev/null @@ -1,8175 +0,0 @@ -openapi: 3.0.0 -servers: - - url: http://vmware.local - - url: https://vrni.example.com/api/ni -info: - description: vRealize Network Insight API Reference - title: vRealize Network Insight API Reference - version: 1.0.0 - x-apisguru-categories: - - developer_tools - x-origin: - - format: swagger - url: https://vdc-download.vmware.com/vmwb-repository/dcr-public/c1b5a60c-3635-4b8c-84b2-3ea54172cf31/f8595072-cedd-4f97-9b05-1720e0f41f92/vrni_api_spec.json - version: "2.0" - x-providerName: vmware.local - x-serviceName: vrni - x-logo: - url: https://api.apis.guru/v2/cache/logo/https_apis.guru_assets_images_no-logo.svg -tags: - - description: Authentication APIs - name: Authentication - - description: Data source APIs - name: Data Sources - - description: Entities APIs - name: Entities - - description: Search APIs - name: Search - - description: Infra APIs - name: Infrastructure - - description: Applications APIs - name: Applications - - description: Micro-segmentation APIs - name: Microsegmentation - - description: Info APIs - name: Info -paths: - /auth/token: - delete: - description: |- - Deletes the auth token provided in Authorization header. - Deleting an expired or invalid token will result in 401 Unauthorized error. - operationId: delete - responses: - "204": - description: Success - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete an auth token. - tags: - - Authentication - post: - description: vRealize Network Insight supports token based authentication.Tokens are non-modifiable identifiers returned by the system when the user has successfully authenticated using valid credentials. Token expires after expiry time returned in the response. All API requests must provide the auth token in Authorization header in following format.
Authorization : NetworkInsight {token}
If a token is invalid or expired, 401-Unauthorized error gets returned in the response of the API request. - operationId: create - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UserCredential" - description: User Credentials - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Token" - expiry: - examples: - response: - value: 1509332642427 - token: - examples: - response: - value: 1rT7tm4riiACSfxrO2BvkA== - description: Success - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - summary: Create an auth token - tags: - - Authentication - /data-sources/arista-switches: - get: - description: List arista switch data sources - operationId: listAristaSwitches - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List arista switch data sources - tags: - - Data Sources - post: - description: Add arista switch data source - operationId: addAristaSwitch - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AristaSwitchDataSourceRequest" - description: Add a cisco switch as datasource - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/AristaSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create an arista switch data source - tags: - - Data Sources - "/data-sources/arista-switches/{id}": - delete: - description: Delete an arista switch data source - operationId: deleteAristaSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete an arista switch data source - tags: - - Data Sources - get: - description: Show arista switch data source details - operationId: getAristaSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AristaSwitchDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show arista switch data source details - tags: - - Data Sources - put: - description: Update an switch data source - operationId: updateAristaSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AristaSwitchDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AristaSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update an arista switch data source - tags: - - Data Sources - "/data-sources/arista-switches/{id}/disable": - post: - description: Disable an arista switch data source - operationId: disableAristaSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable an arista switch data source - tags: - - Data Sources - "/data-sources/arista-switches/{id}/enable": - post: - description: Enable an arista switch data source - operationId: enableAristaSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable an arista switch data source - tags: - - Data Sources - "/data-sources/arista-switches/{id}/snmp-config": - get: - description: Show snmp config for arista switch data source - operationId: getAristaSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for arista switch data source - tags: - - Data Sources - put: - description: Update snmp config for arista switch data source - operationId: updateAristaSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for arista switch data source - tags: - - Data Sources - /data-sources/brocade-switches: - get: - description: List brocade switch data sources - operationId: listBrocadeSwitches - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List brocade switch data sources - tags: - - Data Sources - post: - description: Add brocade switch as a data source - operationId: addBrocadeSwitch - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BrocadeSwitchDataSourceRequest" - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/BrocadeSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a brocade switch data source - tags: - - Data Sources - "/data-sources/brocade-switches/{id}": - delete: - description: Delete a brocade switch data source - operationId: deleteBrocadeSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a brocade switch data source - tags: - - Data Sources - get: - description: Show brocade switch data source details - operationId: getBrocadeSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BrocadeSwitchDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show brocade switch data source details - tags: - - Data Sources - put: - description: Update a brocade switch data source. Only credentials, nickname and notes can be updated. - operationId: updateBrocadeSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BrocadeSwitchDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BrocadeSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a brocade switch data source - tags: - - Data Sources - "/data-sources/brocade-switches/{id}/disable": - post: - operationId: disableBrocadeSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a brocade switch data source - tags: - - Data Sources - "/data-sources/brocade-switches/{id}/enable": - post: - operationId: enableBrocadeSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a brocade switch data source - tags: - - Data Sources - "/data-sources/brocade-switches/{id}/snmp-config": - get: - description: Show snmp config for brocade switch data source - operationId: getBrocadeSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for brocade switch data source - tags: - - Data Sources - put: - description: Update snmp config for brocade switch data source - operationId: updateBrocadeSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for brocade switch data source - tags: - - Data Sources - /data-sources/checkpoint-firewalls: - get: - description: List checkpoint firewall data sources - operationId: listCheckpointFirewalls - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List checkpoint firewall data sources - tags: - - Data Sources - post: - description: Add checkpoint firewall as data source - operationId: addCheckpointFirewall - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CheckpointFirewallDataSourceRequest" - description: Add a vSec Checkpoint firewall as data source - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/CheckpointFirewallDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a checkpoint firewall - tags: - - Data Sources - "/data-sources/checkpoint-firewalls/{id}": - delete: - description: Delete a checkpoint firewall data source - operationId: deleteCheckpointFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a checkpoint firewall data source - tags: - - Data Sources - get: - description: Show checkpoint firewall data source details - operationId: getCheckpointFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/CheckpointFirewallDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show checkpoint firewall data source details - tags: - - Data Sources - put: - description: Update a checkpoint firewall data source - operationId: updateCheckpointFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CheckpointFirewallDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/CheckpointFirewallDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a checkpoint firewall data source - tags: - - Data Sources - "/data-sources/checkpoint-firewalls/{id}/disable": - post: - description: Disable a checkpoint firewall data source - operationId: disableCheckpointFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a checkpoint firewall data source - tags: - - Data Sources - "/data-sources/checkpoint-firewalls/{id}/enable": - post: - description: Enable a checkpoint firewall data source - operationId: enableCheckpointFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a checkpoint firewall data source - tags: - - Data Sources - /data-sources/cisco-switches: - get: - description: List cisco switch data sources - operationId: listCiscoSwitches - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List cisco switch data sources - tags: - - Data Sources - post: - description: |- - Add cisco switch as data source. User must provide one of ip or fqdn field in the request body. - Appropriate proxy id is retrieved from infra/nodes URL to select the proxy node. - operationId: addCiscoSwitch - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CiscoSwitchDataSourceRequest" - description: Add a cisco switch as datasource. - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/CiscoSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a cisco switch data source - tags: - - Data Sources - "/data-sources/cisco-switches/{id}": - delete: - description: Delete a cisco switch data source - operationId: deleteCiscoSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a cisco switch data source - tags: - - Data Sources - get: - description: Show cisco switch data source details - operationId: getCiscoSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/CiscoSwitchDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show cisco switch data source details - tags: - - Data Sources - put: - description: Update a cisco switch data source. Only credentials, nickname and notes can be updated. - operationId: updateCiscoSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CiscoSwitchDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/CiscoSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a cisco switch data source - tags: - - Data Sources - "/data-sources/cisco-switches/{id}/disable": - post: - description: Disable a cisco switch data source - operationId: disableCiscoSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a cisco switch data source - tags: - - Data Sources - "/data-sources/cisco-switches/{id}/enable": - post: - description: Enable a cisco switch data source - operationId: enableCiscoSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a cisco switch data source - tags: - - Data Sources - "/data-sources/cisco-switches/{id}/snmp-config": - get: - description: Show snmp config for cisco switch data source - operationId: getCiscoSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for cisco switch data source - tags: - - Data Sources - put: - description: Update snmp config for cisco switch data source - operationId: updateCiscoSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for cisco switch data source - tags: - - Data Sources - /data-sources/dell-switches: - get: - description: List dell switch data sources - operationId: listDellSwitches - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List dell switch data sources - tags: - - Data Sources - post: - description: Add a dell switch as data source - operationId: addDellSwitch - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DellSwitchDataSourceRequest" - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/DellSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a dell switch data source - tags: - - Data Sources - "/data-sources/dell-switches/{id}": - delete: - description: Delete a data source - operationId: deleteDellSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a dell switch data source - tags: - - Data Sources - get: - description: Get a dell switch data source details - operationId: getDellSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DellSwitchDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show dell switch data source details - tags: - - Data Sources - put: - description: Update a dell switch data source. Only credentials, nickname and notes can be updated - operationId: updateDellSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/DellSwitchDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DellSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a dell switch data source - tags: - - Data Sources - "/data-sources/dell-switches/{id}/disable": - post: - description: Disable a dell switch data source - operationId: disableDellSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a dell switch data source - tags: - - Data Sources - "/data-sources/dell-switches/{id}/enable": - post: - description: Enable a dell switch data source - operationId: enableDellSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a dell switch data source - tags: - - Data Sources - "/data-sources/dell-switches/{id}/snmp-config": - get: - description: Show snmp config for dell switch data source - operationId: getDellSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for dell switch data source - tags: - - Data Sources - put: - description: Update snmp config for dell switch data source - operationId: updateDellSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for dell switch data source - tags: - - Data Sources - /data-sources/hpov-managers: - get: - description: List hp oneview manager data sources - operationId: listHpovManagers - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List hp oneview manager data sources - tags: - - Data Sources - post: - description: Add a hp oneview manager data source - operationId: addHpovManager - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/HPOneViewManagerDataSourceRequest" - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/HPOneViewManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a hp oneview manager data source - tags: - - Data Sources - "/data-sources/hpov-managers/{id}": - delete: - description: Delete a hp oneview data source - operationId: deleteHpovManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a hp oneview data source - tags: - - Data Sources - get: - description: Show hp oneview data source details - operationId: getHpovManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/HPOneViewManagerDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show hp oneview data source details - tags: - - Data Sources - put: - description: Update a hp oneview data source - operationId: updateHpovManager - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/HPOneViewManagerDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/HPOneViewManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a hp oneview data source - tags: - - Data Sources - "/data-sources/hpov-managers/{id}/disable": - post: - description: Disable a hp oneview data source - operationId: disableHpovManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a hp oneview data source - tags: - - Data Sources - "/data-sources/hpov-managers/{id}/enable": - post: - description: Enable a hp oneview data source - operationId: enableHpovManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a hp oneview data source - tags: - - Data Sources - /data-sources/hpvc-managers: - get: - description: List hpvc manager data sources - operationId: listHpvcManagers - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List hpvc manager data sources - tags: - - Data Sources - post: - description: Add hpvc manager data source - operationId: addHpvcManager - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/HPVCManagerDataSourceRequest" - description: Add a switch as datasource - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/HPVCManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a hpvc manager data source - tags: - - Data Sources - "/data-sources/hpvc-managers/{id}": - delete: - description: Delete a hpvc manager data source - operationId: deleteHpvcManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a hpvc manager data source - tags: - - Data Sources - get: - description: Show hpvc data source details - operationId: getHpvcManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/HPVCManagerDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show hpvc data source details - tags: - - Data Sources - put: - description: Update a hpvc manager data source - operationId: updateHpvcManager - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/HPVCManagerDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/HPVCManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a hpvc manager data source - tags: - - Data Sources - "/data-sources/hpvc-managers/{id}/disable": - post: - description: Disable a hpvc manager data source - operationId: disableHpvcManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a hpvc manager data source - tags: - - Data Sources - "/data-sources/hpvc-managers/{id}/enable": - post: - description: Enable a hpvc manager data source - operationId: enableHpvcManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a hpvc manager data source - tags: - - Data Sources - /data-sources/juniper-switches: - get: - description: List juniper switch data sources - operationId: listJuniperSwitches - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List juniper switch data sources - tags: - - Data Sources - post: - description: Add switch Datasource - operationId: addJuniperSwitch - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JuniperSwitchDataSourceRequest" - description: Add a cisco switch as datasource - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/JuniperSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Add a juniper switch as data source - tags: - - Data Sources - "/data-sources/juniper-switches/{id}": - delete: - description: Delete a juniper switch data source - operationId: deleteJuniperSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a juniper switch data source - tags: - - Data Sources - get: - description: Show juniper switch data source details - operationId: getJuniperSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/JuniperSwitchDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show juniper switch data source details - tags: - - Data Sources - put: - description: Update a juniper switch data source - operationId: updateJuniperSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/JuniperSwitchDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/JuniperSwitchDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a juniper switch data source - tags: - - Data Sources - "/data-sources/juniper-switches/{id}/disable": - post: - description: Disable a juniper switch data source - operationId: disableJuniperSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a juniper switch data source - tags: - - Data Sources - "/data-sources/juniper-switches/{id}/enable": - post: - description: Enable a juniper switch data source - operationId: enableJuniperSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a juniper switch data source - tags: - - Data Sources - "/data-sources/juniper-switches/{id}/snmp-config": - get: - description: Show snmp config for juniper switch data source - operationId: getJuniperSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for juniper switch data source - tags: - - Data Sources - put: - description: Update snmp config for a juniper switch data source - operationId: updateJuniperSwitchSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for a juniper switch data source - tags: - - Data Sources - /data-sources/nsxv-managers: - get: - description: List nsx-v manager data sources - operationId: listNsxvManagers - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List nsx-v manager data sources - tags: - - Data Sources - post: - description: Add a nsx-v manager data source - operationId: addNsxvManagerDatasource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/NSXVManagerDataSourceRequest" - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/NSXVManagerDataSource" - description: Success - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a nsx-v manager data source - tags: - - Data Sources - "/data-sources/nsxv-managers/{id}": - delete: - description: Delete a nsx-v manager data source - operationId: deleteNsxvManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a nsx-v manager data source - tags: - - Data Sources - get: - description: Show nsx-v manager data source details - operationId: getNsxvManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NSXVManagerDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show nsx-v manager data source details - tags: - - Data Sources - put: - description: Update a nsx-v manager data source - operationId: updateNsxvManager - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/NSXVManagerDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NSXVManagerDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a nsx-v manager data source - tags: - - Data Sources - "/data-sources/nsxv-managers/{id}/controller-cluster": - get: - description: Show nsx controller-cluster details - operationId: getNsxvControllerCluster - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NSXControllerDataCollection" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show nsx controller-cluster details - tags: - - Data Sources - put: - description: Update nsx controller-cluster details - operationId: updateNsxvControllerCluster - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/NSXControllerDataCollection" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NSXControllerDataCollection" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update nsx controller-cluster details - tags: - - Data Sources - "/data-sources/nsxv-managers/{id}/disable": - post: - description: Disable a nsx-v manager data source - operationId: disableNsxvManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a nsx-v manager data source - tags: - - Data Sources - "/data-sources/nsxv-managers/{id}/enable": - post: - description: Enable a nsx-v manager data source - operationId: enableNsxvManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a nsx-v manager data source - tags: - - Data Sources - /data-sources/panorama-firewalls: - get: - description: List panorama firewall data sources - operationId: listPanoramaFirewalls - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List panorama firewall data sources - tags: - - Data Sources - post: - description: Add panorama firewall as data source - operationId: addPanoramaFirewall - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PanFirewallDataSourceRequest" - description: Add a panorama firewall as datasource - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/PanFirewallDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create panorama firewall data source - tags: - - Data Sources - "/data-sources/panorama-firewalls/{id}": - delete: - description: Delete a panorama firewall data source - operationId: deletePanoramaFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a panorama firewall data source - tags: - - Data Sources - get: - description: Show panorama firewall data source details - operationId: getPanoramaFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PanFirewallDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show panorama firewall data source details - tags: - - Data Sources - put: - description: Update a panorama firewall data source - operationId: updatePanoramaFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/PanFirewallDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PanFirewallDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a panorama firewall data source - tags: - - Data Sources - "/data-sources/panorama-firewalls/{id}/disable": - post: - description: Disable a panorama firewall data source - operationId: disablePanoramaFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a panorama firewall data source - tags: - - Data Sources - "/data-sources/panorama-firewalls/{id}/enable": - post: - description: Enable a panorama firewall data source - operationId: enablePanoramaFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a panorama firewall data source - tags: - - Data Sources - /data-sources/ucs-managers: - get: - description: List ucs manager data sources - operationId: listUcsManagers - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List ucs manager data sources - tags: - - Data Sources - post: - description: Add an ucs manager as data source - operationId: addUcsManager - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UCSManagerDataSourceRequest" - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/UCSManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create an ucs manager data source - tags: - - Data Sources - "/data-sources/ucs-managers/{id}": - delete: - description: Delete an ucs manager data source - operationId: deleteUcsManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete an ucs manager data source - tags: - - Data Sources - get: - description: Show ucs manager data source details - operationId: getUcsManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/UCSManagerDataSource" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show ucs manager data source details - tags: - - Data Sources - put: - description: Update an ucs manager data source - operationId: updateUcsManager - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/UCSManagerDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/UCSManagerDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update an ucs manager data source - tags: - - Data Sources - "/data-sources/ucs-managers/{id}/disable": - post: - description: Disable an ucs manager data source - operationId: disableUcsManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable an ucs manager data source - tags: - - Data Sources - "/data-sources/ucs-managers/{id}/enable": - post: - description: Enable an ucs manager data source - operationId: enableUcsManager - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable an ucs manager data source - tags: - - Data Sources - "/data-sources/ucs-managers/{id}/snmp-config": - get: - description: Show snmp config for ucs fabric interconnects - operationId: getUcsSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show snmp config for ucs fabric interconnects - tags: - - Data Sources - put: - description: Update snmp config for ucs fabric interconnects - operationId: updateUcsSnmpConfig - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - $ref: "#/components/requestBodies/SNMPConfig" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update snmp config for ucs fabric interconnects - tags: - - Data Sources - /data-sources/vcenters: - get: - description: List vCenter data sources - operationId: listVcenters - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DataSourceListResponse" - results: - examples: - response: - value: - - entity_id: 18230:902:993642895 - entity_type: VCenterDataSource - - entity_id: 18230:902:627340998 - entity_type: VCenterDataSource - total_count: - examples: - response: - value: 2 - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vCenter data sources - tags: - - Data Sources - post: - description: |- - Add a vcenter data source. User must provide one of ip or fqdn field in the request body. - Appropriate proxy id is retrieved from infra/nodes URL to select the proxy node. - operationId: addVcenterDatasource - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterDataSourceRequest" - description: VCenter Credentials - required: true - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterDataSource" - credentials: - examples: - response: - value: - password: "" - username: administrator@vsphere.local - enabled: - examples: - response: - value: true - entity_id: - examples: - response: - value: 18230:902:993642895 - entity_type: - examples: - response: - value: VCenterDataSource - fqdn: - examples: - response: - value: null - ip: - examples: - response: - value: 10.197.17.68 - nickname: - examples: - response: - value: aa - notes: - examples: - response: - value: ecmp lab aa - proxy_id: - examples: - response: - value: 18230:901:1585583463 - description: Created - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create a vCenter data source - tags: - - Data Sources - "/data-sources/vcenters/{id}": - delete: - description: Delete a data source - operationId: deleteVcenter - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "204": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete a vCenter data source - tags: - - Data Sources - get: - description: Show vCenter data source details - operationId: getVcenter - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterDataSource" - credentials: - examples: - response: - value: - password: "" - username: administrator@vsphere.local - enabled: - examples: - response: - value: true - entity_id: - examples: - response: - value: 18230:902:993642895 - entity_type: - examples: - response: - value: VCenterDataSource - fqdn: - examples: - response: - value: null - ip: - examples: - response: - value: 10.197.17.68 - nickname: - examples: - response: - value: aa - notes: - examples: - response: - value: ecmp lab - proxy_id: - examples: - response: - value: 18230:901:1585583463 - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vCenter data source details - tags: - - Data Sources - put: - description: Update a vcenter data source. Only nickname, notes and credentials can be updated. - operationId: updateVcenter - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterDataSource" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterDataSource" - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Update a vCenter data source. - tags: - - Data Sources - "/data-sources/vcenters/{id}/disable": - post: - description: Disable a vCenter data source - operationId: disableVcenter - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Disable a vCenter data source - tags: - - Data Sources - "/data-sources/vcenters/{id}/enable": - post: - description: Enable a vCenter data source - operationId: enableVcenter - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Enable a vCenter data source - tags: - - Data Sources - /entities/clusters: - get: - description: List clusters - operationId: listClusters - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509337200 - results: - examples: - response: - value: - - entity_id: 18230:66:1293137396 - entity_type: Cluster - time: 1509282803 - - entity_id: 18230:66:670818039 - entity_type: Cluster - time: 1509284911 - start_time: - examples: - response: - value: 1509337200 - total_count: - examples: - response: - value: 4 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List clusters - tags: - - Entities - "/entities/clusters/{id}": - get: - description: Show cluster details - operationId: getCluster - parameters: - - $ref: "#/components/parameters/Time" - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Cluster" - entity_id: - examples: - response: - value: 18230:66:1293137396 - entity_type: - examples: - response: - value: Cluster - name: - examples: - response: - value: Cluster1 - nsx_manager: - examples: - response: - value: null - num_cpu_cores: - examples: - response: - value: 34 - num_datastores: - examples: - response: - value: 3 - num_hosts: - examples: - response: - value: 3 - total_cpus: - examples: - response: - value: 88400 - total_memory: - examples: - response: - value: 68717867008 - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:2048038620 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: domain-c7 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show cluster details - tags: - - Entities - /entities/datastores: - get: - description: List datastores - operationId: listDatastores - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509337523 - results: - examples: - response: - value: - - entity_id: 18230:80:1756900216 - entity_type: Datastore - time: 1509282874 - - entity_id: 18230:80:682061552 - entity_type: Datastore - time: 1509282819 - start_time: - examples: - response: - value: 1509337523 - total_count: - examples: - response: - value: 6 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List datastores - tags: - - Entities - "/entities/datastores/{id}": - get: - description: Show datastore details - operationId: getDatastore - parameters: - - $ref: "#/components/parameters/Time" - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Datastore" - entity_id: - examples: - response: - value: 18230:80:1756898449 - entity_type: - examples: - response: - value: Datastore - name: - examples: - response: - value: datastore1 (2) - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:824494514 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: datastore-33 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show datastore details - tags: - - Entities - /entities/distributed-virtual-portgroups: - get: - description: List distributed virtual portgroups - operationId: listDistributedVirtualPortgroups - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509345514 - results: - examples: - response: - value: - - entity_id: 18230:3:187309184 - entity_type: DistributedVirtualPortgroup - time: 1509282847 - - entity_id: 18230:3:1603334983 - entity_type: DistributedVirtualPortgroup - time: 1509282885 - start_time: - examples: - response: - value: 1509345514 - total_count: - examples: - response: - value: 46 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List distributed virtual portgroups - tags: - - Entities - "/entities/distributed-virtual-portgroups/{id}": - get: - description: Show distributed virtual portgroup details - operationId: getDistributedVirtualPortgroup - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DistributedVirtualPortgroup" - distributed_virtual_switch: - examples: - response: - value: - entity_id: 18230:2:368016825 - entity_type: DistributedVirtualSwitch - entity_id: - examples: - response: - value: 18230:3:187309184 - entity_type: - examples: - response: - value: DistributedVirtualPortgroup - name: - examples: - response: - value: vxw-dvs-15-virtualwire-18-sid-5017-swargate end vm vxlan - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:2048038620 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: dvportgroup-92 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show distributed virtual portgroup details - tags: - - Entities - /entities/distributed-virtual-switches: - get: - description: List distributed virtual switches - operationId: listDistributedVirtualSwitches - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509345426 - results: - examples: - response: - value: - - entity_id: 18230:2:161257049 - entity_type: DistributedVirtualSwitch - time: 1509282885 - - entity_id: 18230:2:368016825 - entity_type: DistributedVirtualSwitch - time: 1509282854 - start_time: - examples: - response: - value: 1509345426 - total_count: - examples: - response: - value: 2 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List distributed virtual switches - tags: - - Entities - "/entities/distributed-virtual-switches/{id}": - get: - description: Show distributed virtual switch details - operationId: getDistributedVirtualSwitch - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/DistributedVirtualSwitch" - entity_id: - examples: - response: - value: 18230:2:161257049 - entity_type: - examples: - response: - value: DistributedVirtualSwitch - hosts: - examples: - response: - value: - - entity_id: 18230:4:1528136654 - entity_type: Host - - entity_id: 18230:4:1528138514 - entity_type: Host - - entity_id: 18230:4:1528136747 - entity_type: Host - name: - examples: - response: - value: dvSwitch - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:824494514 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: dvs-21 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show distributed virtual switch details - tags: - - Entities - /entities/firewall-rules: - get: - description: List firewall rules - operationId: listFirewallRules - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509344618 - results: - examples: - response: - value: - - entity_id: 18230:87:367271162 - entity_type: NSXFirewallRule - time: 1509283319 - - entity_id: 18230:87:367270232 - entity_type: NSXFirewallRule - time: 1509283319 - start_time: - examples: - response: - value: 1509344618 - total_count: - examples: - response: - value: 7 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List firewall rules - tags: - - Entities - "/entities/firewall-rules/{id}": - get: - description: Show firewall rule details - operationId: getFirewallRule - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - action: - examples: - response: - value: ALLOW - application/json: - schema: - $ref: "#/components/schemas/BaseFirewallRule" - destination_any: - examples: - response: - value: true - destination_inversion: - examples: - response: - value: false - destinations: - examples: - response: - value: [] - direction: - examples: - response: - value: INOUT - disabled: - examples: - response: - value: false - entity_id: - examples: - response: - value: 18230:87:367271162 - entity_type: - examples: - response: - value: NSXFirewallRule - logging_enabled: - examples: - response: - value: false - name: - examples: - response: - value: Default Rule - nsx_managers: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - port_ranges: - examples: - response: - value: - - display: 0-65535 (ANY) - end: 65535 - iana_name: "" - iana_port_display: "" - start: 0 - rule_id: - examples: - response: - value: "1001" - scope: - examples: - response: - value: GLOBAL - section_id: - examples: - response: - value: "1003" - section_name: - examples: - response: - value: Default Section Layer3 - sequence_number: - examples: - response: - value: 6 - service_any: - examples: - response: - value: true - services: - examples: - response: - value: [] - source_any: - examples: - response: - value: true - source_inversion: - examples: - response: - value: false - sources: - examples: - response: - value: [] - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show firewall rule details - tags: - - Entities - /entities/firewalls: - get: - description: List firewalls - operationId: listFirewalls - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509344618 - results: - examples: - response: - value: - - entity_id: 18230:39:660899929 - entity_type: NSXDistributedFirewall - time: 1509283319 - start_time: - examples: - response: - value: 1509344618 - total_count: - examples: - response: - value: 1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List firewalls - tags: - - Entities - "/entities/firewalls/{id}": - get: - description: Show firewall details - operationId: getFirewall - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseFirewallRule" - entity_id: - examples: - response: - value: 18230:39:660899929 - entity_type: - examples: - response: - value: NSXDistributedFirewall - exclusions: - examples: - response: - value: - - entity_id: 18230:1:875338882 - entity_type: VirtualMachine - firewall_rules: - examples: - response: - value: - - rule_set_type: NSX_STANDARD - rules: [] - - rules: [] - name: - examples: - response: - value: NSX Firewall - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show firewall details - tags: - - Entities - /entities/flows: - get: - description: List flows - operationId: getFlows - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509339942 - results: - examples: - response: - value: - - entity_id: 10000:515:1491521924 - entity_type: Flow - time: 1509283320 - start_time: - examples: - response: - value: 1509339942 - total_count: - examples: - response: - value: 3 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List flows - tags: - - Entities - "/entities/flows/{id}": - get: - description: Show flow details - operationId: getFlow - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Flow" - destination_folders: - examples: - response: - value: [] - destination_ip: - examples: - response: - value: - ip_address: 10.197.53.38 - netmask: 255.255.255.255 - network_address: 10.197.53.38 - destination_ip_sets: - examples: - response: - value: [] - destination_security_groups: - examples: - response: - value: [] - destination_security_tags: - examples: - response: - value: [] - destination_vm_tags: - examples: - response: - value: [] - entity_id: - examples: - response: - value: 10000:515:1491521924 - entity_type: - examples: - response: - value: Flow - firewall_action: - examples: - response: - value: ALLOW - flow_tag: - examples: - response: - value: - - EAST_WEST_TRAFFIC - - PHY_PHY_TRAFFIC - - SRC_IP_PHYSICAL - name: - examples: - response: - value: 10.197.53.40 -> 10.197.53.38 [port:500] - port: - examples: - response: - value: - display: "500" - end: 500 - iana_name: isakmp - iana_port_display: 500 [isakmp] - start: 500 - protocol: - examples: - response: - value: UDP - source_folders: - examples: - response: - value: [] - source_ip: - examples: - response: - value: - ip_address: 10.197.53.40 - netmask: 255.255.255.255 - network_address: 10.197.53.40 - source_ip_sets: - examples: - response: - value: [] - source_security_groups: - examples: - response: - value: [] - source_security_tags: - examples: - response: - value: [] - source_vm_tags: - examples: - response: - value: [] - traffic_type: - examples: - response: - value: EAST_WEST_TRAFFIC - within_host: - examples: - response: - value: false - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show flow details - tags: - - Entities - /entities/folders: - get: - description: List folders - operationId: listFolders - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509337459 - results: - examples: - response: - value: - - entity_id: 18230:81:591055243 - entity_type: Folder - time: 1509282871 - - entity_id: 18230:81:520432789 - entity_type: Folder - time: 1509282804 - start_time: - examples: - response: - value: 1509337459 - total_count: - examples: - response: - value: 14 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List folders - tags: - - Entities - "/entities/folders/{id}": - get: - description: Show folder details - operationId: getFolder - parameters: - - $ref: "#/components/parameters/Time" - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Folder" - entity_id: - examples: - response: - value: 18230:81:591055243 - entity_type: - examples: - response: - value: Folder - name: - examples: - response: - value: datastore - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:824494514 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: group-s5 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show folder details - tags: - - Entities - /entities/hosts: - get: - description: List hosts - operationId: listHosts - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509336095 - results: - examples: - response: - value: - - entity_id: 18230:4:652218965 - entity_type: Host - time: 1509283414 - - entity_id: 18230:4:1256074202 - entity_type: Host - time: 1509283414 - start_time: - examples: - response: - value: 1509336095 - total_count: - examples: - response: - value: 6 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List hosts - tags: - - Entities - "/entities/hosts/{id}": - get: - description: Show host details - operationId: getHost - parameters: - - $ref: "#/components/parameters/Time" - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Host" - cluster: - examples: - response: - value: - entity_id: 18230:66:1293137396 - entity_type: Cluster - connection_state: - examples: - response: - value: CONNECTED - datastores: - examples: - response: - value: - - entity_id: 18230:80:330903629 - entity_type: Datastore - entity_id: - examples: - response: - value: 18230:4:1256074202 - entity_type: - examples: - response: - value: Host - maintenance_mode: - examples: - response: - value: NOTINMAINTENANCEMODE - name: - examples: - response: - value: 10.197.17.228 - nsx_manager: - examples: - response: - value: null - service_tag: - examples: - response: - value: VMware-42 14 cd 9f f0 c8 0f 77-6a 53 71 8c 6d d6 e3 ff - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:2048038620 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: host-202 - vm_count: - examples: - response: - value: 0 - vmknics: - examples: - response: - value: - - entity_id: 18230:17:1776349286 - entity_type: Vmknic - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show host details - tags: - - Entities - /entities/ip-sets: - get: - description: List ip sets - operationId: listIPSets - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509339942 - results: - examples: - response: - value: - - entity_id: 18230:84:347816011 - entity_type: NSXIPSet - time: 1509283320 - start_time: - examples: - response: - value: 1509339942 - total_count: - examples: - response: - value: 3 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List ip sets - tags: - - Entities - "/entities/ip-sets/{id}": - get: - description: Show ip set details - operationId: getIPSet - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseIPSet" - direct_destination_rules: - examples: - response: - value: [] - direct_source_rules: - examples: - response: - value: [] - entity_id: - examples: - response: - value: 18230:84:347816011 - entity_type: - examples: - response: - value: NSXIPSet - indirect_destination_rules: - examples: - response: - value: [] - indirect_source_rules: - examples: - response: - value: [] - ip_addresses: - examples: - response: - value: [] - ip_numeric_ranges: - examples: - response: - value: - - end: 3232255518 - start: 3232255509 - ip_ranges: - examples: - response: - value: - - end_ip: 192.168.78.30 - start_ip: 192.168.78.21 - name: - examples: - response: - value: IPSET_ford - nsx_managers: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - parent_security_groups: - examples: - response: - value: [] - scope: - examples: - response: - value: GLOBAL - translated_vm_count: - examples: - response: - value: 0 - vendor: - examples: - response: - value: "" - vendor_id: - examples: - response: - value: ipset-3 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show ip set details - tags: - - Entities - /entities/layer2-networks: - get: - description: List layer2 networks - operationId: listLayer2Networks - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509339711 - results: - examples: - response: - value: - - entity_id: 18230:11:2095237606 - entity_type: VxlanLayer2Network - time: 1509284850 - - entity_id: 18230:11:2095237668 - entity_type: VxlanLayer2Network - time: 1509284850 - start_time: - examples: - response: - value: 1509339711 - total_count: - examples: - response: - value: 38 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List layer2 networks - tags: - - Entities - "/entities/layer2-networks/{id}": - get: - description: Show layer2 network details - operationId: getLayer2Network - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseL2Network" - entity_id: - examples: - response: - value: 18230:11:2095237606 - entity_type: - examples: - response: - value: VxlanLayer2Network - gateways: - examples: - response: - value: [] - name: - examples: - response: - value: Deccan-uplink-vxlan - network_addresses: - examples: - response: - value: - - 192.168.13.0/24 - nsx_managers: - examples: - response: - value: [] - scope: - examples: - response: - value: GLOBAL - segment_id: - examples: - response: - value: 5004 - vteps: - examples: - response: - value: - - entity_id: 18230:17:695819287 - entity_type: Vmknic - - entity_id: 18230:17:431576805 - entity_type: Vmknic - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show layer2 network details - tags: - - Entities - /entities/names: - post: - description: Get names for entities.Limit of 1000 entities in a single request. - operationId: getNames - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/NamesRequest" - description: Names Request - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NamesResponse" - description: OK - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Get names for entities - tags: - - Entities - "/entities/names/{id}": - get: - description: Get name of an entity - operationId: getName - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/EntityName" - description: OK - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Get name of an entity - tags: - - Entities - /entities/nsx-managers: - get: - description: List nsx managers - operationId: listNSXManagers - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509345346 - results: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - time: 1509339744 - start_time: - examples: - response: - value: 1509345346 - total_count: - examples: - response: - value: 1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List nsx managers - tags: - - Entities - "/entities/nsx-managers/{id}": - get: - description: Show nsx manager details - operationId: getNSXManager - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseNSXManager" - entity_id: - examples: - response: - value: 18230:7:824494449 - entity_type: - examples: - response: - value: NSXVManager - ip_address: - examples: - response: - value: - ip_address: 10.197.53.187 - netmask: 255.255.255.255 - network_address: 10.197.53.187/32 - name: - examples: - response: - value: 10.197.53.187 - role: - examples: - response: - value: STANDALONE - version: - examples: - response: - value: 6.2.8 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show nsx manager details - tags: - - Entities - /entities/problems: - get: - description: List problem events. - operationId: listProblemEvents - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509318396 - results: - examples: - response: - value: - - entity_id: 18230:35230:1233393386 - entity_type: ProblemEvent - time: 1509283820 - - entity_id: 18230:35228:1832167524 - entity_type: ProblemEvent - time: 1509285022 - start_time: - examples: - response: - value: 1509231996 - total_count: - examples: - response: - value: 15 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List problems - tags: - - Entities - "/entities/problems/{id}": - get: - description: Show problem event details. - operationId: getProblemEvent - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - admin_state: - examples: - response: - value: ENABLED - anchor_entities: - examples: - response: - value: - - entity_id: 18230:39:660899929 - entity_type: NSXDistributedFirewall - application/json: - schema: - $ref: "#/components/schemas/ProblemEvent" - archived: - examples: - response: - value: false - entity_id: - examples: - response: - value: 18230:36050:1583312594 - entity_type: - examples: - response: - value: ProblemEvent - event_tags: - examples: - response: - value: - - Best Practices - - Firewall - event_time_epoch_ms: - examples: - response: - value: 1509283819834 - message: - examples: - response: - value: The distributed firewall is configured to allow all traffic by default, which increases the potential attack surface of the network - name: - examples: - response: - value: NSXFirewallDefaultAllowAllRulesEvent - related_entities: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - - entity_id: 18230:87:367271162 - entity_type: NSXFirewallRule - - entity_id: 18230:39:660899929 - entity_type: NSXDistributedFirewall - severity: - examples: - response: - value: INFO - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show problem details - tags: - - Entities - /entities/security-groups: - get: - description: List security groups - operationId: listSecurityGroups - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509340012 - results: - examples: - response: - value: - - entity_id: 18230:82:1504518253 - entity_type: NSXSecurityGroup - time: 1509283316 - - entity_id: 18230:82:604574196 - entity_type: NSXSecurityGroup - time: 1509284912 - start_time: - examples: - response: - value: 1509340012 - total_count: - examples: - response: - value: 9 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List security groups - tags: - - Entities - "/entities/security-groups/{id}": - get: - description: Show security group details - operationId: getSecurityGroup - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseSecurityGroup" - direct_destination_rules: - examples: - response: - value: [] - direct_members: - examples: - response: - value: - - entity_id: 18230:99:922343691 - entity_type: SecurityTag - direct_source_rules: - examples: - response: - value: [] - entity_id: - examples: - response: - value: 18230:82:604574196 - entity_type: - examples: - response: - value: NSXSecurityGroup - excluded_members: - examples: - response: - value: [] - indirect_destination_rules: - examples: - response: - value: [] - indirect_source_rules: - examples: - response: - value: [] - ip_sets: - examples: - response: - value: [] - members: - examples: - response: - value: - - entity_id: 18230:99:922343691 - entity_type: SecurityTag - name: - examples: - response: - value: SG-TestApp-Web - nsx_managers: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - parents: - examples: - response: - value: [] - scope: - examples: - response: - value: GLOBAL - security_tags: - examples: - response: - value: - - entity_id: 18230:99:922343691 - entity_type: SecurityTag - translated_vm_count: - examples: - response: - value: 0 - vendor_id: - examples: - response: - value: securitygroup-25 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show security group details - tags: - - Entities - /entities/security-tags: - get: - description: List security tags - operationId: listSecurityTags - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509340096 - results: - examples: - response: - value: - - entity_id: 18230:99:922344652 - entity_type: SecurityTag - time: 1509283319 - - entity_id: 18230:99:1830868297 - entity_type: SecurityTag - time: 1509283318 - start_time: - examples: - response: - value: 1509340096 - total_count: - examples: - response: - value: 14 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List security tags - tags: - - Entities - "/entities/security-tags/{id}": - get: - description: Show security tag details - operationId: getSecurityTag - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/SecurityTag" - description: - examples: - response: - value: Tag indicates that the data violation detected has a medium threat level - direct_security_groups: - examples: - response: - value: [] - entity_id: - examples: - response: - value: 18230:99:922344652 - entity_type: - examples: - response: - value: SecurityTag - name: - examples: - response: - value: IDS_IPS.threat=medium - nsx_manager: - examples: - response: - value: - entity_id: 18230:7:824494449 - entity_type: NSXVManager - security_groups: - examples: - response: - value: [] - vendor_id: - examples: - response: - value: securitytag-10 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show security tag details - tags: - - Entities - /entities/service-groups: - get: - description: List service groups - operationId: listServiceGroups - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509344618 - results: - examples: - response: - value: - - entity_id: 18230:86:1504518253 - entity_type: NSXServiceGroup - time: 1509283319 - start_time: - examples: - response: - value: 1509344618 - total_count: - examples: - response: - value: 1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List service groups - tags: - - Entities - "/entities/service-groups/{id}": - get: - description: Show service group details - operationId: getServiceGroup - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseServiceGroup" - entity_id: - examples: - response: - value: 18230:86:505347433 - entity_type: - examples: - response: - value: NSXServiceGroup - members: - examples: - response: - value: - - entity_id: 18230:85:676477656 - entity_type: NSXService - - entity_id: 18230:85:503998082 - entity_type: NSXService - - entity_id: 18230:85:504027904 - entity_type: NSXService - - entity_id: 18230:85:676474897 - entity_type: NSXService - name: - examples: - response: - value: Oracle Enterprise Manager - nsx_managers: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - scope: - examples: - response: - value: GLOBAL - vendor_id: - examples: - response: - value: applicationgroup-23 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show service group details - tags: - - Entities - /entities/services: - get: - description: List services - operationId: listServices - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509344618 - results: - examples: - response: - value: - - entity_id: 18230:85:503995168 - entity_type: NSXService - time: 1509283319 - start_time: - examples: - response: - value: 1509344618 - total_count: - examples: - response: - value: 1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List services - tags: - - Entities - "/entities/services/{id}": - get: - description: Show service details - operationId: getService - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseService" - entity_id: - examples: - response: - value: 18230:85:503995168 - entity_type: - examples: - response: - value: NSXService - name: - examples: - response: - value: PostgresSQL - nsx_managers: - examples: - response: - value: - - entity_id: 18230:7:824494449 - entity_type: NSXVManager - port_ranges: - examples: - response: - value: - - display: "5432" - end: 5432 - iana_name: "" - iana_port_display: "" - start: 5432 - protocol: - examples: - response: - value: TCP - scope: - examples: - response: - value: GLOBAL - vendor_id: - examples: - response: - value: application-211 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show service details - tags: - - Entities - /entities/vc-datacenters: - get: - description: List vCenter datacenters - operationId: listDatacenters - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509337402 - results: - examples: - response: - value: - - entity_id: 18230:105:192022336 - entity_type: VCDatacenter - time: 1509282871 - - entity_id: 18230:105:1663983066 - entity_type: VCDatacenter - time: 1509282803 - start_time: - examples: - response: - value: 1509337402 - total_count: - examples: - response: - value: 2 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vCenter datacenters - tags: - - Entities - "/entities/vc-datacenters/{id}": - get: - description: Show vCenter datacenter details - operationId: getDatacenter - parameters: - - $ref: "#/components/parameters/Time" - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/VCDatacenter" - entity_id: - examples: - response: - value: 18230:105:192022336 - entity_type: - examples: - response: - value: VCDatacenter - name: - examples: - response: - value: DataCenter - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:824494514 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: datacenter-2 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vCenter datacenter details - tags: - - Entities - /entities/vcenter-managers: - get: - description: List vCenter managers - operationId: listVcenterManagers - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: null - end_time: - examples: - response: - value: 1509344794 - results: - examples: - response: - value: - - entity_id: 18230:8:2048038620 - entity_type: VCenterManager - time: 1509282805 - - entity_id: 18230:8:824494514 - entity_type: VCenterManager - time: 1509283017 - start_time: - examples: - response: - value: 1509344794 - total_count: - examples: - response: - value: 2 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vCenter managers - tags: - - Entities - "/entities/vcenter-managers/{id}": - get: - description: Show vCenter manager details - operationId: getVcenterManager - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/VCenterManager" - entity_id: - examples: - response: - value: 18230:8:2048038620 - entity_type: - examples: - response: - value: VCenterManager - ip_address: - examples: - response: - value: - ip_address: 10.197.17.68 - netmask: 255.255.255.255 - network_address: 10.197.17.68/32 - name: - examples: - response: - value: 10.197.17.68 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vCenter manager details - tags: - - Entities - /entities/vmknics: - get: - description: List vmknics - operationId: listVmknics - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509337586 - results: - examples: - response: - value: - - entity_id: 18230:17:1928372608 - entity_type: Vmknic - time: 1509283321 - - entity_id: 18230:17:695819318 - entity_type: Vmknic - time: 1509282819 - start_time: - examples: - response: - value: 1509337586 - total_count: - examples: - response: - value: 11 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vmknics - tags: - - Entities - "/entities/vmknics/{id}": - get: - description: Show vmknic details - operationId: getVmknic - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Vmknic" - entity_id: - examples: - response: - value: 18230:17:695819318 - entity_type: - examples: - response: - value: Vmknic - host: - examples: - response: - value: - entity_id: 18230:4:652218965 - entity_type: Host - ip_addresses: - examples: - response: - value: - - ip_address: 10.197.17.64 - netmask: 255.255.252.0 - network_address: 10.197.16.0/22 - layer2_network: - examples: - response: - value: null - name: - examples: - response: - value: "[10.197.17.64]-[vmk0]" - vlan: - examples: - response: - value: - begin: 0 - end: 0 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vmknic details - tags: - - Entities - /entities/vms: - get: - description: List vms - operationId: listVms - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509335034 - results: - examples: - response: - value: - - entity_id: 18230:1:1158969162 - entity_type: VirtualMachine - time: 1509283414 - - entity_id: 18230:1:875338851 - entity_type: VirtualMachine - time: 1509283476 - start_time: - examples: - response: - value: 1509335034 - total_count: - examples: - response: - value: 39 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vms - tags: - - Entities - "/entities/vms/{id}": - get: - description: Show vm details - operationId: getVm - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseVirtualMachine" - applied_to_destination_rules: - examples: - response: - value: [] - applied_to_source_rules: - examples: - response: - value: [] - cluster: - examples: - response: - value: - entity_id: 18230:66:1293137396 - entity_type: Cluster - datacenter: - examples: - response: - value: - entity_id: 18230:105:1663983066 - entity_type: VCDatacenter - datastores: - examples: - response: - value: - - entity_id: 18230:80:682061552 - entity_type: Datastore - default_gateway: - examples: - response: - value: "" - destination_firewall_rules: - examples: - response: - value: [] - destination_inversion_rules: - examples: - response: - value: [] - entity_id: - examples: - response: - value: 18230:1:1158969162 - entity_type: - examples: - response: - value: VirtualMachine - folders: - examples: - response: - value: - - entity_id: 18230:81:520432789 - entity_type: Folder - host: - examples: - response: - value: - entity_id: 18230:4:652218965 - entity_type: Host - ip_addresses: - examples: - response: - value: - - ip_address: 10.197.17.74 - netmask: 255.255.255.0 - network_address: 10.197.17.0/24 - ip_sets: - examples: - response: - value: [] - layer2_networks: - examples: - response: - value: [] - name: - examples: - response: - value: NSX_Controller_9e80ec74-57ce-4671-8fd7-b5884a997535 - nsx_manager: - examples: - response: - value: null - resource_pool: - examples: - response: - value: - entity_id: 18230:79:313158344 - entity_type: ResourcePool - security_groups: - examples: - response: - value: [] - security_tags: - examples: - response: - value: [] - source_firewall_rules: - examples: - response: - value: [] - source_inversion_rules: - examples: - response: - value: [] - vcenter_manager: - examples: - response: - value: - entity_id: 18230:8:2048038620 - entity_type: VCenterManager - vendor_id: - examples: - response: - value: vm-181 - vlans: - examples: - response: - value: [] - vnics: - examples: - response: - value: - - entity_id: 18230:18:863301374 - entity_type: Vnic - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vm details - tags: - - Entities - /entities/vnics: - get: - description: List vnics - operationId: listVnics - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - cursor: - examples: - response: - value: MTA= - end_time: - examples: - response: - value: 1509335034 - results: - examples: - response: - value: - - entity_id: 18230:18:1158969162 - entity_type: Vnic - time: 1509283414 - - entity_id: 18230:18:875338851 - entity_type: Vnic - time: 1509283476 - start_time: - examples: - response: - value: 1509335034 - total_count: - examples: - response: - value: 39 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List vnics - tags: - - Entities - "/entities/vnics/{id}": - get: - description: Show vnic details - operationId: getVnic - parameters: - - $ref: "#/components/parameters/Identifier" - - $ref: "#/components/parameters/Time" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/BaseVnic" - entity_id: - examples: - response: - value: 18230:18:1285494944 - entity_type: - examples: - response: - value: Vnic - ip_addresses: - examples: - response: - value: [] - layer2_network: - examples: - response: - value: null - name: - examples: - response: - value: "[USA Edge-0]-[Network adapter 8]" - vlan: - examples: - response: - value: - begin: 0 - end: 0 - vm: - examples: - response: - value: - entity_id: 18230:1:1158972882 - entity_type: VirtualMachine - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show vnic details - tags: - - Entities - /groups/applications: - get: - description: List applications - operationId: listApplications - parameters: - - $ref: "#/components/parameters/Size" - - $ref: "#/components/parameters/Cursor" - - $ref: "#/components/parameters/StartTime" - - $ref: "#/components/parameters/EndTime" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponse" - results: - examples: - response: - value: - - entity_id: 18230:561:271275765 - entity_type: Application - total_count: - examples: - response: - value: 1 - description: OK - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List applications - tags: - - Applications - post: - description: |- - Application is a group of tiers. A tier is a group of virtual machines based on membership criteria. Tiers are bound to single - application. An application name is unique and should not conflict with another application name. - operationId: addApplication - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ApplicationRequest" - required: true - responses: - "201": - content: - application/json: - schema: - $ref: "#/components/schemas/Application" - create_time: - examples: - response: - value: 1509410056733 - created_by: - examples: - response: - value: admin@local - entity_id: - examples: - response: - value: 18230:561:271275765 - entity_type: - examples: - response: - value: Application - last_modified_by: - examples: - response: - value: "" - last_modified_time: - examples: - response: - value: 0 - name: - examples: - response: - value: App-1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create an application - tags: - - Applications - "/groups/applications/{id}": - delete: - description: Deleting an application deletes all the tiers of the application along with the application - operationId: deleteApplication - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "204": - description: Success - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete an application - tags: - - Applications - get: - description: Show application details - operationId: getApplication - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Application" - create_time: - examples: - response: - value: 1509410056733 - created_by: - examples: - response: - value: admin@local - entity_id: - examples: - response: - value: 18230:561:271275765 - entity_type: - examples: - response: - value: Application - last_modified_by: - examples: - response: - value: "" - last_modified_time: - examples: - response: - value: 0 - name: - examples: - response: - value: App-1 - description: OK - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show application details - tags: - - Applications - "/groups/applications/{id}/tiers": - get: - description: List tiers of an application - operationId: listApplicationTiers - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/TierListResponse" - results: - examples: - response: - value: - - application: - entity_id: 18230:561:271275765 - entity_type: Application - entity_id: 18230:562:1266458745 - entity_type: Tier - group_membership_criteria: - - membership_type: SearchMembershipCriteria - search_membership_criteria: - entity_type: VirtualMachine - filter: security_groups.entity_id = '18230:82:604573173' - name: tier-1 - description: OK - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List tiers of an application - tags: - - Applications - post: - description: |- - Create a tier of an application by with specified membership criteria. The membership criteria id defined in terms of - virtual machines or ip addresses/subnet. Please refer to API Guide on how to construct membership criteria. - operationId: addTier - parameters: - - $ref: "#/components/parameters/Identifier" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/TierRequest" - required: true - responses: - "201": - content: - application: - examples: - response: - value: - entity_id: 18230:561:271275765 - entity_type: Application - application/json: - schema: - $ref: "#/components/schemas/Tier" - entity_id: - examples: - response: - value: 18230:562:1266458745 - entity_type: - examples: - response: - value: Tier - group_membership_criteria: - examples: - response: - value: - - membership_type: SearchMembershipCriteria - search_membership_criteria: - entity_type: VirtualMachine - filter: security_groups.entity_id = '18230:82:604573173' - name: - examples: - response: - value: tier-1 - description: OK - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Create tier in application - tags: - - Applications - "/groups/applications/{id}/tiers/{tier-id}": - delete: - description: Delete tier of an application - operationId: deleteTier - parameters: - - $ref: "#/components/parameters/Identifier" - - in: path - name: tier-id - required: true - schema: - type: string - responses: - "204": - description: OK - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Delete tier - tags: - - Applications - get: - description: Show tier details - operationId: getApplicationTier - parameters: - - $ref: "#/components/parameters/Identifier" - - in: path - name: tier-id - required: true - schema: - type: string - responses: - "200": - content: - application: - examples: - response: - value: - entity_id: 18230:561:271275765 - entity_type: Application - application/json: - schema: - $ref: "#/components/schemas/Tier" - entity_id: - examples: - response: - value: 18230:562:1266458745 - entity_type: - examples: - response: - value: Tier - group_membership_criteria: - examples: - response: - value: - - membership_type: SearchMembershipCriteria - search_membership_criteria: - entity_type: VirtualMachine - filter: security_groups.entity_id = '18230:82:604573173' - name: - examples: - response: - value: tier-1 - description: OK - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show tier details - tags: - - Applications - "/groups/tiers/{tier-id}": - get: - description: Show tier details - operationId: getTier - parameters: - - in: path - name: tier-id - required: true - schema: - type: string - - description: Authorization Header - in: header - name: Authorization - required: true - schema: - format: NetworkInsight - type: string - responses: - "200": - content: - application: - examples: - response: - value: - entity_id: 18230:561:271275765 - entity_type: Application - application/json: - schema: - $ref: "#/components/schemas/Tier" - entity_id: - examples: - response: - value: 18230:562:1266458745 - entity_type: - examples: - response: - value: Tier - group_membership_criteria: - examples: - response: - value: - - membership_type: SearchMembershipCriteria - search_membership_criteria: - entity_type: VirtualMachine - filter: security_groups.entity_id = '18230:82:604573173' - name: - examples: - response: - value: tier-1 - description: OK - "401": - description: Unauthorized - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show tier details - tags: - - Applications - /info/version: - get: - description: Show version info - operationId: getVersion - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/VersionResponse" - description: OK - "401": - description: Unauthorized - security: - - ApiKeyAuth: [] - summary: Show version info - tags: - - Info - /infra/nodes: - get: - description: Get list of infrastructure nodes. Only admin users can retrieve this information. - operationId: listNodes - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/NodeListResult" - results: - examples: - response: - value: - - entity_type: NODE - id: 18230:901:1585583463 - - entity_type: NODE - id: 18230:901:1706494033 - total_count: - examples: - response: - value: 2 - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: List nodes - tags: - - Infrastructure - "/infra/nodes/{id}": - get: - description: |- - Get details of infrastructure nodes. Only admin users can get this information. The proxy id is - required for adding a data source for selecting appropriate proxy node to add the data source. - operationId: getNode - parameters: - - $ref: "#/components/parameters/Identifier" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Node" - entity_type: - examples: - response: - value: NODE - id: - examples: - response: - value: 18230:901:1585583463 - ip_address: - examples: - response: - value: 10.126.103.156 - node_id: - examples: - response: - value: IOYHU2J - node_type: - examples: - response: - value: PROXY_VM - description: OK - "401": - description: Unauthorized - "403": - description: Forbidden - "404": - description: Not Found - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Show node details - tags: - - Infrastructure - /micro-seg/recommended-rules: - post: - description: |- - Get recommended firewall rules based on the flow data gathered by vRealize Network Insight. - This API provides service to retrieve recommended rules based on flow traffic that is observed between - two groups OR for a single group based on all the inbound and outboud traffic for that group. - In case two groups are provided, both the groups should be of same type. - Currently supported groups are Application, Tier, NSXSecurityGroup, EC2SecurityGroup. - operationId: listRecommendedRules - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/RecommendedRulesRequest" - description: Recommended Rules Request - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/RecommendedRules" - results: - examples: - response: - value: - - action: ALLOW - destinations: - - entity_id: 10000:562:1780351215 - entity_type: Tier - port_ranges: - - end: 53 - start: 53 - - end: 1025 - start: 1025 - protocols: - - UDP - sources: - - entity_id: 10000:562:1904698621 - entity_type: Tier - time_range: - examples: - response: - value: - end_time_epoch: 1509083319391 - start_time_epoch: 1508996919391 - description: Success - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Get logical recommended rules - tags: - - Microsegmentation - /micro-seg/recommended-rules/nsx: - post: - description: |- - Export recommended firewall rules based on the flow data gathered by vRealize Network Insight in NSX-V compatible - format - operationId: exportNsxRecommendedRules - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/RecommendedRulesRequest" - description: NSX Recommended Rules Request - responses: - "200": - content: - application/octet-stream: - schema: - format: binary - type: string - description: Success - "400": - content: - application/octet-stream: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Export recommended rules for NSX-V - tags: - - Microsegmentation - /search: - post: - description: |- - Using search API you can search vRealize Network Insight entities by specifying entity type and filter expression. - A filter expression is a predicate expression (similar to SQL where clause) used to define the search criteria. - Please refer to API Guide on details of how to construct filter expression. A successful search request will return a - list of entity ids that matches the search criteria. - operationId: searchEntities - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchRequest" - description: Search Request - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/PagedListResponseWithTime" - description: Success - "400": - content: - application/json: - schema: - $ref: "#/components/schemas/ApiError" - description: Bad Request - "401": - description: Unauthorized - "500": - description: Internal Error - security: - - ApiKeyAuth: [] - summary: Search entities - tags: - - Search -components: - parameters: - Cursor: - description: cursor from previous response - in: query - name: cursor - required: false - schema: - type: string - EndTime: - description: end time for query in epoch seconds - in: query - name: end_time - required: false - schema: - type: number - Identifier: - description: entity id - in: path - name: id - required: true - schema: - type: string - Size: - description: page size of results - in: query - name: size - required: false - schema: - default: 10 - type: number - StartTime: - description: start time for query in epoch seconds - in: query - name: start_time - required: false - schema: - type: number - Time: - description: time in epoch seconds - in: query - name: time - required: false - schema: - format: int64 - type: integer - requestBodies: - SNMPConfig: - content: - application/json: - schema: - $ref: "#/components/schemas/SNMPConfig" - schemas: - AllEntityType: - enum: - - Group - - BaseSecurityGroup - - BaseEvent - - BaseVirtualMachine - - BaseFirewallRule - - BaseIPSet - - BaseL2Network - - BaseFirewall - - BaseService - - BaseServiceGroup - - BaseVnic - - VirtualMachine - - EC2Instance - - Host - - Vnic - - Vmknic - - VxlanLayer2Network - - VlanL2Network - - Cluster - - SecurityTag - - ResourcePool - - NSXIPSet - - EC2IPSet - - NSXSecurityGroup - - EC2SecurityGroup - - Flow - - ProblemEvent - - Application - - Tier - - NSXFirewallRule - - EC2SGFirewallRule - - NSXRedirectRule - - VCenterManager - - NSXVManager - - BaseManager - - BaseNSXManager - - NSXService - - EC2Service - - VPC - - NSXDistributedFirewall - - EC2Firewall - - NSXServiceGroup - - DistributedVirtualSwitch - - DistributedVirtualPortgroup - - VCDatacenter - - Datastore - - Folder - type: string - ApiError: - properties: - code: - format: int32 - type: integer - details: - items: - $ref: "#/components/schemas/ErrorDetail" - type: array - message: - type: string - type: object - Application: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - create_time: - format: int64 - type: integer - created_by: - type: string - last_modified_by: - type: string - last_modified_time: - format: int64 - type: integer - ApplicationRequest: - properties: - name: - type: string - type: object - AristaSwitchDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - AristaSwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - BaseDataSource: - discriminator: - propertyName: entity_type - properties: - enabled: - default: true - type: boolean - entity_id: - type: string - entity_type: - $ref: "#/components/schemas/DataSourceType" - fqdn: - example: your.domain.com - type: string - ip: - example: 192.168.10.1 - type: string - nickname: - example: vc1 - type: string - notes: - type: string - proxy_id: - description: proxy vm which should register this vcenter - example: 1000:104:12313412 - type: string - type: object - BaseDataSourceRequest: - properties: - enabled: - default: true - type: boolean - fqdn: - example: your.domain.com - type: string - ip: - example: 192.168.10.1 - type: string - nickname: - example: vc1 - type: string - notes: - type: string - proxy_id: - description: proxy vm which should register this vcenter - example: 1000:104:12313412 - type: string - required: - - proxy_id - - nickname - type: object - BaseEntity: - discriminator: - propertyName: entity_type - properties: - entity_id: - type: string - entity_type: - $ref: "#/components/schemas/EntityType" - name: - type: string - type: object - BaseEvent: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - admin_state: - enum: - - ENABLED - - DISABLED - type: string - anchor_entities: - items: - $ref: "#/components/schemas/Reference" - type: array - archived: - type: boolean - event_tags: - items: - type: string - type: array - event_time_epoch_ms: - format: int64 - type: integer - message: - type: string - related_entities: - items: - $ref: "#/components/schemas/Reference" - type: array - BaseFirewall: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - exclusions: - items: - $ref: "#/components/schemas/Reference" - type: array - firewall_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - BaseFirewallRule: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - action: - $ref: "#/components/schemas/FirewallAction" - destination_any: - type: boolean - destination_inversion: - type: boolean - destinations: - items: - $ref: "#/components/schemas/Reference" - type: array - disabled: - type: boolean - port_ranges: - items: - $ref: "#/components/schemas/PortRange" - type: array - rule_id: - type: string - section_id: - type: string - section_name: - type: string - sequence_number: - type: integer - service_any: - type: boolean - services: - items: - $ref: "#/components/schemas/Reference" - type: array - source_any: - type: boolean - source_inversion: - type: boolean - sources: - items: - $ref: "#/components/schemas/Reference" - type: array - BaseIPSet: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - direct_destination_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - direct_source_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - indirect_destination_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - indirect_source_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - ip_addresses: - items: - $ref: "#/components/schemas/IpV4Address" - type: array - ip_numeric_ranges: - items: - $ref: "#/components/schemas/IpNumericRange" - type: array - ip_ranges: - items: - $ref: "#/components/schemas/IpAddressRange" - type: array - parent_security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - translated_vm_count: - format: int32 - type: integer - vendor: - type: string - vendor_id: - type: string - BaseL2Network: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - gateways: - items: - type: string - type: array - network_addresses: - items: - type: string - type: array - BaseManager: - allOf: - - $ref: "#/components/schemas/BaseEntity" - BaseNSXManager: - allOf: - - $ref: "#/components/schemas/BaseManager" - BaseSecurityGroup: - allOf: - - $ref: "#/components/schemas/Group" - - properties: - direct_destination_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - direct_members: - items: - $ref: "#/components/schemas/Reference" - type: array - direct_source_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - excluded_members: - items: - $ref: "#/components/schemas/Reference" - type: array - indirect_destination_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - indirect_source_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - members: - items: - $ref: "#/components/schemas/Reference" - type: array - parents: - items: - $ref: "#/components/schemas/Reference" - type: array - translated_vm_count: - type: integer - vendor_id: - type: string - BaseService: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - port_ranges: - items: - $ref: "#/components/schemas/PortRange" - type: array - protocol: - type: string - BaseServiceGroup: - allOf: - - $ref: "#/components/schemas/Group" - BaseVirtualMachine: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - default_gateway: - type: string - destination_firewall_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - ip_addresses: - items: - $ref: "#/components/schemas/IpV4Address" - type: array - ip_sets: - items: - $ref: "#/components/schemas/Reference" - type: array - security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - source_firewall_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - vnics: - items: - $ref: "#/components/schemas/Reference" - type: array - type: object - BaseVnic: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - ip_addresses: - items: - $ref: "#/components/schemas/IpV4Address" - type: array - layer2_network: - $ref: "#/components/schemas/Reference" - vlan: - $ref: "#/components/schemas/Vlan" - vm: - $ref: "#/components/schemas/Reference" - BrocadeSwitchDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - BrocadeSwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - CheckpointFirewallDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - CheckpointFirewallDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - CiscoSwitchDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - - properties: - switch_type: - $ref: "#/components/schemas/CiscoSwitchType" - CiscoSwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - - properties: - switch_type: - $ref: "#/components/schemas/CiscoSwitchType" - CiscoSwitchType: - enum: - - CATALYST_3000 - - CATALYST_4500 - - CATALYST_6500 - - NEXUS_5K - - NEXUS_7K - - NEXUS_9K - type: string - Cluster: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - nsx_manager: - $ref: "#/components/schemas/Reference" - num_cpu_cores: - format: int32 - type: integer - num_datastores: - format: int32 - type: integer - num_hosts: - format: int32 - type: integer - total_cpus: - format: int32 - type: integer - total_memory: - format: int64 - type: integer - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - DataSourceEntityId: - properties: - entity_id: - description: Entity Identifier - example: 1000:104:12213212 - type: string - entity_type: - $ref: "#/components/schemas/DataSourceType" - type: object - DataSourceListResponse: - properties: - results: - items: - $ref: "#/components/schemas/DataSourceEntityId" - type: array - total_count: - example: 1 - type: integer - type: object - DataSourceType: - enum: - - CiscoSwitchDataSource - - DellSwitchDataSource - - AristaSwitchDataSource - - BrocadeSwitchDataSource - - JuniperSwitchDataSource - - VCenterDataSource - - NSXVManagerDataSource - - UCSManagerDataSource - - HPVCManagerDataSource - - HPOneViewDataSource - - PanFirewallDataSource - - CheckpointFirewallDataSource - type: string - DatasourceHealth: - description: Datasource Health state - properties: - health_error_code: - type: string - health_message: - type: string - health_status: - enum: - - HEALTHY - - HEALTHY_WITH_WARNINGS - - UNHEALTHY - type: string - type: object - Datastore: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - DellSwitchDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - - properties: - switch_type: - $ref: "#/components/schemas/DellSwitchType" - DellSwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - - properties: - switch_type: - $ref: "#/components/schemas/DellSwitchType" - DellSwitchType: - enum: - - FORCE_10_MXL_10 - - POWERCONNECT_8024 - - S4048 - - Z9100 - - S6000 - type: string - DistributedVirtualPortgroup: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - distributed_virtual_switch: - $ref: "#/components/schemas/Reference" - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - DistributedVirtualSwitch: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - hosts: - items: - $ref: "#/components/schemas/Reference" - type: array - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - Domain: - properties: - domain_type: - enum: - - LDAP - - LOCAL - example: LDAP - type: string - value: - description: domain value, not required for LOCAL domain - example: example.com - type: string - type: object - EC2Firewall: - allOf: - - $ref: "#/components/schemas/BaseFirewall" - EC2FirewallDirection: - enum: - - INBOUND - - OUTBOUND - type: string - EC2IPSet: - allOf: - - $ref: "#/components/schemas/BaseIPSet" - EC2Instance: - allOf: - - $ref: "#/components/schemas/BaseVirtualMachine" - - properties: - region: - type: string - vpc: - $ref: "#/components/schemas/Reference" - EC2NetworkInterface: - allOf: - - $ref: "#/components/schemas/BaseVnic" - EC2SGFirewallRule: - allOf: - - $ref: "#/components/schemas/BaseFirewallRule" - - properties: - direction: - $ref: "#/components/schemas/EC2FirewallDirection" - owner_security_group: - $ref: "#/components/schemas/Reference" - vpc: - $ref: "#/components/schemas/Reference" - EC2SecurityGroup: - allOf: - - $ref: "#/components/schemas/BaseSecurityGroup" - - properties: - region: - type: string - vpc: - $ref: "#/components/schemas/Reference" - EC2Service: - allOf: - - $ref: "#/components/schemas/BaseService" - EntityId: - properties: - entity_id: - description: Entity Identifier - example: 1000:104:12213212 - type: string - entity_type: - $ref: "#/components/schemas/EntityType" - type: object - EntityIdWithTime: - properties: - entity_id: - description: Entity Identifier - type: string - entity_type: - $ref: "#/components/schemas/EntityType" - time: - format: int64 - type: integer - type: object - EntityName: - allOf: - - $ref: "#/components/schemas/EntityIdWithTime" - - properties: - name: - type: string - EntityType: - enum: - - VirtualMachine - - EC2Instance - - Host - - Vnic - - Vmknic - - VxlanLayer2Network - - VlanL2Network - - Cluster - - SecurityTag - - ResourcePool - - NSXIPSet - - EC2IPSet - - NSXSecurityGroup - - EC2SecurityGroup - - Flow - - ProblemEvent - - Application - - Tier - - NSXFirewallRule - - EC2SGFirewallRule - - NSXRedirectRule - - VCenterManager - - NSXVManager - - NSXService - - EC2Service - - VPC - - NSXDistributedFirewall - - EC2Firewall - - NSXServiceGroup - - DistributedVirtualSwitch - - DistributedVirtualPortgroup - - VCDatacenter - - Datastore - - Folder - type: string - ErrorDetail: - properties: - code: - format: int32 - type: integer - message: - type: string - target: - items: - type: string - type: array - type: object - FirewallAction: - enum: - - ALLOW - - ACCEPT - - DENY - - DROP - - REJECT - - REDIRECT - - DO_NOT_REDIRECT - type: string - FirewallDirection: - enum: - - IN - - OUT - - INOUT - type: string - Flow: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - destination_cluster: - $ref: "#/components/schemas/Reference" - destination_datacenter: - $ref: "#/components/schemas/Reference" - destination_folders: - items: - $ref: "#/components/schemas/Reference" - type: array - destination_host: - $ref: "#/components/schemas/Reference" - destination_ip: - $ref: "#/components/schemas/IpV4Address" - destination_ip_sets: - items: - $ref: "#/components/schemas/Reference" - type: array - destination_l2_network: - $ref: "#/components/schemas/Reference" - destination_resource_pool: - $ref: "#/components/schemas/Reference" - destination_security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - destination_security_tags: - items: - $ref: "#/components/schemas/Reference" - type: array - destination_vm: - $ref: "#/components/schemas/Reference" - destination_vm_tags: - items: - type: string - type: array - destination_vnic: - $ref: "#/components/schemas/Reference" - destination_vpc: - $ref: "#/components/schemas/Reference" - firewall_action: - $ref: "#/components/schemas/FirewallAction" - flow_tag: - items: - $ref: "#/components/schemas/FlowTag" - type: array - port: - $ref: "#/components/schemas/PortRange" - protocol: - $ref: "#/components/schemas/Protocol" - source_cluster: - $ref: "#/components/schemas/Reference" - source_datacenter: - $ref: "#/components/schemas/Reference" - source_folders: - items: - $ref: "#/components/schemas/Reference" - type: array - source_host: - $ref: "#/components/schemas/Reference" - source_ip: - $ref: "#/components/schemas/IpV4Address" - source_ip_sets: - items: - $ref: "#/components/schemas/Reference" - type: array - source_l2_network: - $ref: "#/components/schemas/Reference" - source_resource_pool: - $ref: "#/components/schemas/Reference" - source_security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - source_security_tags: - items: - $ref: "#/components/schemas/Reference" - type: array - source_vm: - $ref: "#/components/schemas/Reference" - source_vm_tags: - items: - type: string - type: array - source_vnic: - $ref: "#/components/schemas/Reference" - source_vpc: - $ref: "#/components/schemas/Reference" - traffic_type: - $ref: "#/components/schemas/FlowTrafficType" - within_host: - type: boolean - FlowTag: - enum: - - TAG_TRAFFIC_TYPE_UNKNOWN - - TAG_INTERNET_TRAFFIC - - TAG_EAST_WEST_TRAFFIC - - TAG_VM_VM_TRAFFIC - - TAG_VM_PHY_TRAFFIC - - TAG_PHY_PHY_TRAFFIC - - TAG_SRC_IP_VMKNIC - - TAG_DST_IP_VMKNIC - - TAG_SRC_IP_VM - - TAG_DST_IP_VM - - TAG_SRC_IP_INTERNET - - TAG_DST_IP_INTERNET - - TAG_SRC_IP_PHYSICAL - - TAG_DST_IP_PHYSICAL - - TAG_SAME_HOST - - TAG_DIFF_HOST - - TAG_SHARED_SERVICE - - TAG_NOT_SHARED_SERVICE - - TAG_NETWORK_SWITCHED - - TAG_NETWORK_ROUTED - - TAG_NETWORK_UNKNOWN - - TAG_SRC_IP_VTEP - - TAG_DST_IP_VTEP - - TAG_UNICAST - - TAG_BROADCAST - - TAG_MULTICAST - - TAG_SRC_IP_LINK_LOCAL - - TAG_DST_IP_LINK_LOCAL - - TAG_SRC_IP_CLASS_E - - TAG_DST_IP_CLASS_E - - TAG_SRC_IP_CLASS_A_RESERVED - - TAG_DST_IP_CLASS_A_RESERVED - - TAG_INVALID_IP_PACKETS - - TAG_NOT_ANALYZED - - TAG_GENERIC_INTERNET_SRC_IP - - TAG_SNAT_DNAT_FLOW - - TAG_MULTINICS - - TAG_SRC_VC - - TAG_DST_VC - - TAG_SRC_AWS - - TAG_DST_AWS - - TAG_WITHIN_DC - - TAG_DIFF_DC - - TAG_WITHIN_VPC - - TAG_DIFF_VPC - type: string - FlowTrafficType: - enum: - - INTERNET_TRAFFIC - - EAST_WEST_TRAFFIC - type: string - Folder: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - Group: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - members: - items: - $ref: "#/components/schemas/Reference" - type: array - GroupMembershipCriteria: - description: EntityType currently restricted to VirtualMachine - properties: - ip_address_membership_criteria: - $ref: "#/components/schemas/IpAddressMembershipCriteria" - membership_type: - enum: - - SearchMembershipCriteria - - IPAddressMembershipCriteria - type: string - search_membership_criteria: - $ref: "#/components/schemas/SearchMembershipCriteria" - type: object - HPOneViewManagerDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - HPOneViewManagerDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - HPVCManagerDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - HPVCManagerDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - Host: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - cluster: - $ref: "#/components/schemas/Reference" - connection_state: - type: string - datastores: - items: - $ref: "#/components/schemas/Reference" - type: array - maintenance_mode: - type: string - nsx_manager: - $ref: "#/components/schemas/Reference" - service_tag: - type: string - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - vm_count: - format: int32 - type: integer - vmknics: - items: - $ref: "#/components/schemas/Reference" - type: array - IpAddressMembershipCriteria: - description: Ip Address membership definition - properties: - ip_addresses: - items: - type: string - type: array - type: object - IpAddressRange: - properties: - end_ip: - type: string - start_ip: - type: string - IpNumericRange: - properties: - end: - format: int64 - type: integer - start: - format: int64 - type: integer - IpV4Address: - properties: - ip_address: - type: string - netmask: - type: string - network_address: - type: string - type: object - JuniperSwitchDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - JuniperSwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - MetaEntityType: - enum: - - Group - - BaseSecurityGroup - - BaseEvent - - BaseVirtualMachine - - BaseFirewallRule - - BaseIPSet - - BaseL2Network - - BaseManager - - BaseNSXManager - - BaseFirewall - - BaseService - - BaseServiceGroup - - BaseVnic - type: string - MicroSecGroup: - properties: - entity: - $ref: "#/components/schemas/Reference" - type: object - NSXControllerDataCollection: - properties: - controller_password: - type: string - enabled: - default: false - type: boolean - type: object - NSXDistributedFirewall: - allOf: - - $ref: "#/components/schemas/BaseFirewall" - - properties: - vendor_id: - type: string - NSXFirewallRule: - allOf: - - $ref: "#/components/schemas/BaseFirewallRule" - - properties: - direction: - $ref: "#/components/schemas/FirewallDirection" - logging_enabled: - type: boolean - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - NSXIPSet: - allOf: - - $ref: "#/components/schemas/BaseIPSet" - - properties: - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - NSXRedirectRule: - allOf: - - $ref: "#/components/schemas/BaseFirewallRule" - - properties: - direction: - $ref: "#/components/schemas/FirewallDirection" - logging_enabled: - type: boolean - service_profile: - type: string - NSXSecurityGroup: - allOf: - - $ref: "#/components/schemas/BaseSecurityGroup" - - properties: - ip_sets: - items: - $ref: "#/components/schemas/Reference" - type: array - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - security_tags: - items: - $ref: "#/components/schemas/Reference" - type: array - NSXService: - allOf: - - $ref: "#/components/schemas/BaseService" - - properties: - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - vendor_id: - type: string - NSXServiceGroup: - allOf: - - $ref: "#/components/schemas/BaseServiceGroup" - - properties: - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - vendor_id: - type: string - NSXVManager: - allOf: - - $ref: "#/components/schemas/BaseNSXManager" - - properties: - fqdn: - type: string - ip_address: - $ref: "#/components/schemas/IpV4Address" - primary_nsx_manager: - $ref: "#/components/schemas/Reference" - role: - type: string - version: - type: string - vm: - $ref: "#/components/schemas/Reference" - NSXVManagerDataSource: - allOf: - - $ref: "#/components/schemas/BaseDataSource" - - properties: - central_cli_enabled: - default: false - type: boolean - credentials: - $ref: "#/components/schemas/PasswordCredentials" - ipfix_enabled: - default: false - type: boolean - vcenter_id: - description: Associated vcenter data source entity Id - type: string - NSXVManagerDataSourceRequest: - allOf: - - $ref: "#/components/schemas/BaseDataSourceRequest" - - properties: - central_cli_enabled: - default: false - type: boolean - credentials: - $ref: "#/components/schemas/PasswordCredentials" - ipfix_enabled: - default: false - type: boolean - vcenter_id: - description: Associated vcenter data source entity Id - type: string - required: - - vcenter_id - - credentials - NameRequestParam: - properties: - entity_id: - type: string - time: - format: int64 - type: integer - type: object - NamesRequest: - properties: - entities: - items: - $ref: "#/components/schemas/NameRequestParam" - type: array - type: object - NamesResponse: - properties: - entities: - items: - $ref: "#/components/schemas/EntityName" - type: array - type: object - Node: - properties: - entity_type: - $ref: "#/components/schemas/NodeType" - id: - type: string - ip_address: - type: string - name: - type: string - node_id: - type: string - node_type: - enum: - - PROXY_VM - - PLATFORM_VM - type: string - type: object - NodeId: - properties: - entity_type: - $ref: "#/components/schemas/NodeType" - id: - description: Entity Identifier - example: 1000:104:12213212 - type: string - type: object - NodeListResult: - properties: - results: - items: - $ref: "#/components/schemas/NodeId" - type: array - total_count: - example: 1 - type: integer - type: object - NodeType: - enum: - - Node - type: string - PagedListResponse: - properties: - cursor: - type: string - end_time: - format: int64 - type: integer - results: - items: - $ref: "#/components/schemas/EntityId" - type: array - start_time: - format: int64 - type: integer - total_count: - type: integer - type: object - PagedListResponseWithTime: - properties: - cursor: - example: ML12eu02== - type: string - end_time: - example: 1504739809 - format: int64 - type: integer - results: - items: - $ref: "#/components/schemas/EntityIdWithTime" - type: array - start_time: - example: 1504739809 - format: int64 - type: integer - total_count: - example: 100 - type: integer - type: object - PanFirewallDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - PanFirewallDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSourceRequest" - PasswordCredentials: - properties: - password: - type: string - username: - type: string - required: - - username - - password - type: object - PortRange: - properties: - display: - type: string - end: - format: int32 - type: integer - iana_name: - type: string - iana_port_display: - type: string - start: - format: int32 - type: integer - type: object - ProblemEvent: - allOf: - - $ref: "#/components/schemas/BaseEvent" - - properties: - event_close_time_epoch_ms: - format: int64 - type: integer - severity: - enum: - - CRITICAL - - MODERATE - - WARNING - - INFO - type: string - Protocol: - enum: - - TCP - - UDP - - OTHER - type: string - RecommendedRule: - properties: - action: - enum: - - ALLOW - - DROP - type: string - destinations: - items: - $ref: "#/components/schemas/Reference" - type: array - port_ranges: - items: - $ref: "#/components/schemas/SimplePortRange" - type: array - protocols: - items: - type: string - type: array - sources: - items: - $ref: "#/components/schemas/Reference" - type: array - type: object - RecommendedRules: - properties: - results: - items: - $ref: "#/components/schemas/RecommendedRule" - type: array - time_range: - $ref: "#/components/schemas/TimeRange" - type: object - RecommendedRulesRequest: - example: - group_1: - entity: - entity_id: 10000:562:1904698621 - entity_type: Tier - group_2: - entity: - entity_id: 10000:562:1780351215 - entity_type: Tier - properties: - group_1: - $ref: "#/components/schemas/MicroSecGroup" - group_2: - $ref: "#/components/schemas/MicroSecGroup" - time_range: - $ref: "#/components/schemas/TimeRange" - type: object - Reference: - properties: - entity_id: - type: string - entity_type: - $ref: "#/components/schemas/EntityType" - type: object - ResourcePool: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - RuleSet: - properties: - firewall: - $ref: "#/components/schemas/Reference" - rule_set_type: - enum: - - NSX_STANDARD - - NSX_REDIRECT - - AWS_STANDARD - type: string - rules: - items: - $ref: "#/components/schemas/Reference" - type: array - type: object - SNMP2cConfig: - properties: - community_string: - type: string - type: object - SNMP3Config: - properties: - authentication_password: - type: string - authentication_type: - enum: - - NO_AUTH - - MD5 - - SHA - type: string - context_name: - type: string - privacy_password: - type: string - privacy_type: - enum: - - AES - - DES - - AES128 - - AES192 - - AES256 - - 3DES - - NO_PRIV - type: string - username: - type: string - type: object - SNMPConfig: - properties: - config_snmp_2c: - $ref: "#/components/schemas/SNMP2cConfig" - config_snmp_3: - $ref: "#/components/schemas/SNMP3Config" - snmp_enabled: - default: false - type: boolean - snmp_version: - enum: - - v2c - - v3 - type: string - type: object - ScopeEnum: - enum: - - UNIVERSAL - - GLOBAL - type: string - SearchMembershipCriteria: - properties: - entity_type: - $ref: "#/components/schemas/AllEntityType" - filter: - description: As defined in search end point - type: string - type: object - SearchRequest: - properties: - cursor: - type: string - entity_type: - $ref: "#/components/schemas/AllEntityType" - filter: - description: query filter - type: string - size: - format: int32 - type: integer - sort_by: - $ref: "#/components/schemas/SortByClause" - time_range: - $ref: "#/components/schemas/TimeRange" - type: object - SecurityTag: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - description: - type: string - direct_security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - nsx_manager: - $ref: "#/components/schemas/Reference" - security_groups: - items: - $ref: "#/components/schemas/Reference" - type: array - vendor_id: - type: string - SimpleListResponse: - properties: - results: - items: - $ref: "#/components/schemas/EntityId" - type: array - total_count: - type: integer - type: object - SimplePortRange: - properties: - end: - format: int32 - type: integer - start: - format: int32 - type: integer - type: object - SortByClause: - properties: - field: - type: string - order: - enum: - - ASC - - DESC - type: string - type: object - SwitchDataSource: - allOf: - - $ref: "#/components/schemas/BaseDataSource" - - properties: - credentials: - $ref: "#/components/schemas/PasswordCredentials" - SwitchDataSourceRequest: - allOf: - - $ref: "#/components/schemas/BaseDataSourceRequest" - - properties: - credentials: - $ref: "#/components/schemas/PasswordCredentials" - Tier: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - application: - $ref: "#/components/schemas/Reference" - group_membership_criteria: - items: - $ref: "#/components/schemas/GroupMembershipCriteria" - type: array - TierListResponse: - properties: - results: - items: - $ref: "#/components/schemas/Tier" - type: array - type: object - TierRequest: - example: - group_membership_criteria: - - membership_type: SearchMembershipCriteria - search_membership_criteria: - entity_type: VirtualMachine - filter: security_groups.entity_id = '18230:82:604573173' - name: tier-1 - properties: - group_membership_criteria: - items: - $ref: "#/components/schemas/GroupMembershipCriteria" - type: array - name: - type: string - type: object - TimeRange: - properties: - end_time: - format: int64 - type: integer - start_time: - format: int64 - type: integer - type: object - Token: - properties: - expiry: - description: expiry epoch time in secs. - format: int64 - type: integer - token: - type: string - type: object - UCSManagerDataSource: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - UCSManagerDataSourceRequest: - allOf: - - $ref: "#/components/schemas/SwitchDataSource" - UserCredential: - properties: - domain: - $ref: "#/components/schemas/Domain" - password: - example: password - type: string - username: - example: admin@vrni.com - type: string - type: object - VCDatacenter: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - type: object - VCenterDataSource: - allOf: - - $ref: "#/components/schemas/BaseDataSource" - - properties: - credentials: - $ref: "#/components/schemas/PasswordCredentials" - example: - credentials: - password: thePassword - username: admin@vsphere.local - enabled: true - entity_type: VCenterDataSource - fqdn: go.vc.org - id: 1000:33:12890123 - ip: 192.168.10.1 - nickname: vc1 - notes: VC 1 - proxy_id: 1000:104:12313412 - VCenterDataSourceRequest: - allOf: - - $ref: "#/components/schemas/BaseDataSourceRequest" - - properties: - credentials: - $ref: "#/components/schemas/PasswordCredentials" - VCenterManager: - allOf: - - $ref: "#/components/schemas/BaseManager" - - properties: - fqdn: - type: string - ip_address: - $ref: "#/components/schemas/IpV4Address" - nsx_manager: - $ref: "#/components/schemas/Reference" - vm: - $ref: "#/components/schemas/Reference" - VPC: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - cidr_block: - $ref: "#/components/schemas/IpV4Address" - default_vpc: - type: boolean - last_synched_time: - format: int64 - type: integer - region: - type: string - state: - type: string - vendor_id: - type: string - VersionResponse: - properties: - api_version: - type: string - type: object - VirtualMachine: - allOf: - - $ref: "#/components/schemas/BaseVirtualMachine" - - properties: - applied_to_destination_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - applied_to_source_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - cluster: - $ref: "#/components/schemas/Reference" - datacenter: - $ref: "#/components/schemas/Reference" - datastores: - items: - $ref: "#/components/schemas/Reference" - type: array - destination_inversion_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - folders: - items: - $ref: "#/components/schemas/Reference" - type: array - host: - $ref: "#/components/schemas/Reference" - layer2_networks: - items: - $ref: "#/components/schemas/Reference" - type: array - nsx_manager: - $ref: "#/components/schemas/Reference" - resource_pool: - $ref: "#/components/schemas/Reference" - security_tags: - items: - $ref: "#/components/schemas/Reference" - type: array - source_inversion_rules: - items: - $ref: "#/components/schemas/RuleSet" - type: array - vcenter_manager: - $ref: "#/components/schemas/Reference" - vendor_id: - type: string - vlans: - items: - $ref: "#/components/schemas/Vlan" - type: array - Vlan: - properties: - begin: - type: integer - x-searchable: true - end: - type: integer - type: object - VlanL2Network: - allOf: - - $ref: "#/components/schemas/BaseL2Network" - - properties: - distributed_virtual_portgroups: - items: - $ref: "#/components/schemas/Reference" - type: array - distributed_virtual_switches: - items: - $ref: "#/components/schemas/Reference" - type: array - vlan_id: - type: string - Vmknic: - allOf: - - $ref: "#/components/schemas/BaseEntity" - - properties: - host: - $ref: "#/components/schemas/Reference" - ip_addresses: - items: - $ref: "#/components/schemas/IpV4Address" - type: array - layer2_network: - $ref: "#/components/schemas/Reference" - vlan: - $ref: "#/components/schemas/Vlan" - Vnic: - allOf: - - $ref: "#/components/schemas/BaseVnic" - VxlanLayer2Network: - allOf: - - $ref: "#/components/schemas/BaseL2Network" - - properties: - nsx_managers: - items: - $ref: "#/components/schemas/Reference" - type: array - scope: - $ref: "#/components/schemas/ScopeEnum" - segment_id: - format: int32 - type: integer - vteps: - items: - $ref: "#/components/schemas/Reference" - type: array - securitySchemes: - ApiKeyAuth: - description: API Key - NetworkInsight {token} - in: header - name: Authorization - type: apiKey diff --git a/packages/openapi-parser/tests/files/whatsapplocal.yaml b/packages/openapi-parser/tests/files/whatsapplocal.yaml deleted file mode 100644 index 1432aa5..0000000 --- a/packages/openapi-parser/tests/files/whatsapplocal.yaml +++ /dev/null @@ -1,3408 +0,0 @@ -openapi: 3.0.0 -servers: - - url: http://whatsapp.local - - url: http://example.com/v1 -info: - contact: - x-twitter: WhatsApp - description: See https://developers.facebook.com/docs/whatsapp - title: WhatsApp Business API - version: "1.0" - x-apisguru-categories: - - messaging - x-logo: - url: https://api.apis.guru/v2/cache/logo/https_twitter.com_WhatsApp_profile_image.png - x-origin: - - format: openapi - url: https://raw.githubusercontent.com/unblu/WhatsApp-Business-API-OpenAPI/master/openapi.yaml - version: "3.0" - x-providerName: whatsapp.local - x-unofficialSpec: true -security: - - bearerAuth: [] -tags: - - name: Users - - name: Application - - name: Backup/Restore - - name: Business Profile - - name: Profile - - name: Two-Step Verification - - name: Registration - - name: Contacts - - name: Messages - - name: Groups - - name: Media - - name: Health - - name: Certificates -paths: - /account: - post: - deprecated: false - operationId: RequestCode - requestBody: - content: - application/json: - example: - cc: - cert: - method: sms - phone_number: - pin: - phone_number: - pin: - shards: 32 - schema: - $ref: "#/components/schemas/Set-Shards-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Set-Shards - tags: - - Application - /account/verify: - post: - deprecated: false - operationId: RegisterAccount - requestBody: - content: - application/json: - example: - code: - schema: - $ref: "#/components/schemas/Register-Account-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Register-Account - tags: - - Registration - /certificates/external: - post: - deprecated: false - operationId: UploadCertificate - requestBody: - content: - text/plain: - schema: - format: binary - type: string - responses: - "200": - description: "" - summary: Upload-Certificate - tags: - - Certificates - /certificates/external/ca: - get: - deprecated: false - operationId: DownloadCaCertificate - responses: - "200": - content: - text/plain: - schema: - format: binary - type: string - description: "" - summary: Download-CA-Certificate - tags: - - Certificates - /certificates/webhooks/ca: - delete: - deprecated: false - operationId: DeleteWebhookCaCertificate - responses: - "200": - description: "" - summary: Delete Webhook CA Certificate - tags: - - Certificates - get: - deprecated: false - operationId: DownloadWebhookCaCertificate - responses: - "200": - content: - text/plain: - schema: - format: binary - type: string - description: "" - summary: Download Webhook CA Certificate - tags: - - Certificates - post: - deprecated: false - operationId: UploadWebhookCaCertificate - requestBody: - content: - text/plain: - schema: - format: binary - type: string - required: false - responses: - "200": - description: "" - summary: Upload Webhook CA Certificate - tags: - - Certificates - /contacts: - post: - deprecated: false - operationId: CheckContact - requestBody: - content: - application/json: - example: - blocking: wait - contacts: - - "{{Recipient-WA-ID}}" - schema: - $ref: "#/components/schemas/Check-Contact-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Check-Contact-Response" - description: "" - summary: Check-Contact - tags: - - Contacts - /groups: - get: - deprecated: false - operationId: GetAllGroups - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Groups-Response" - description: "" - summary: Get-All-Groups - tags: - - Groups - post: - deprecated: false - operationId: CreateGroup - requestBody: - content: - application/json: - example: - subject: - schema: - $ref: "#/components/schemas/Create-Group-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Groups-Response" - description: "" - summary: Create-Group - tags: - - Groups - "/groups/{GroupId}": - get: - deprecated: false - operationId: GetGroupInfo - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Group-Response" - description: "" - summary: Get-Group-Info - tags: - - Groups - put: - deprecated: false - operationId: UpdateGroupInfo - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - application/json: - example: - subject: - schema: - $ref: "#/components/schemas/Update-Group-Info-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Update-Group-Info - tags: - - Groups - "/groups/{GroupId}/admins": - delete: - deprecated: false - operationId: DemoteGroupAdmin - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - application/json: - example: - wa_ids: - - - schema: - $ref: "#/components/schemas/Group-Admin-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Demote-Group-Admin - tags: - - Groups - patch: - deprecated: false - operationId: PromoteToGroupAdmin - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - application/json: - example: - wa_ids: - - - schema: - $ref: "#/components/schemas/Group-Admin-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Promote-To-Group-Admin - tags: - - Groups - "/groups/{GroupId}/icon": - delete: - deprecated: false - operationId: DeleteGroupIcon - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - multipart/form-data: - schema: - properties: - File: - format: binary - type: string - required: - - File - type: object - required: false - responses: - "200": - description: "" - summary: Delete-Group-Icon - tags: - - Groups - get: - deprecated: false - operationId: GetGroupIconBinary - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - responses: - "200": - description: "" - summary: Get-Group-Icon-Binary - tags: - - Groups - post: - deprecated: false - operationId: SetGroupIcon - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - multipart/form-data: - schema: - properties: - File: - format: binary - type: string - required: - - File - type: object - required: false - responses: - "200": - description: "" - summary: Set-Group-Icon - tags: - - Groups - "/groups/{GroupId}/invite": - delete: - deprecated: false - operationId: DeleteGroupInvite - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - responses: - "200": - description: "" - summary: Delete-Group-Invite - tags: - - Groups - get: - deprecated: false - operationId: GetGroupInvite - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Group-Invite-Response" - description: "" - summary: Get-Group-Invite - tags: - - Groups - "/groups/{GroupId}/leave": - post: - deprecated: false - operationId: LeaveGroup - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - responses: - "200": - description: "" - summary: Leave-Group - tags: - - Groups - "/groups/{GroupId}/participants": - delete: - deprecated: false - operationId: RemoveGroupParticipant - parameters: - - description: "" - explode: false - in: path - name: GroupId - required: true - schema: - type: string - style: simple - requestBody: - content: - application/json: - example: - wa_ids: - - "{{Recipient-WA-ID}}" - schema: - $ref: "#/components/schemas/Remove-Group-Participant-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Remove-Group-Participant - tags: - - Groups - /health: - get: - deprecated: false - operationId: CheckHealth - responses: - "200": - description: "" - summary: Check-Health - tags: - - Health - /media: - post: - deprecated: false - operationId: UploadMedia - requestBody: - content: - application/msword: - schema: - format: binary - type: string - application/pdf: - schema: - format: binary - type: string - application/vnd.ms-excel: - schema: - format: binary - type: string - application/vnd.ms-powerpoint: - schema: - format: binary - type: string - audio/acc: - schema: - format: binary - type: string - audio/amr: - schema: - format: binary - type: string - audio/mp4: - schema: - format: binary - type: string - audio/mpeg: - schema: - format: binary - type: string - audio/ogg: - schema: - format: binary - type: string - codecs=opus: - schema: - format: binary - type: string - image/jpeg: - schema: - format: binary - type: string - image/png: - schema: - format: binary - type: string - text/plain: - schema: - format: binary - type: string - video/mp4: - schema: - format: binary - type: string - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Upload-Media-Response" - description: "" - summary: Upload-Media - tags: - - Media - "/media/{MediaId}": - delete: - deprecated: false - operationId: DeleteMedia - parameters: - - description: "" - explode: false - in: path - name: MediaId - required: true - schema: - type: string - style: simple - responses: - "200": - description: "" - summary: Delete-Media - tags: - - Media - get: - deprecated: false - operationId: DownloadMedia - parameters: - - description: "" - explode: false - in: path - name: MediaId - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: {} - description: "" - summary: Download-Media - tags: - - Media - /messages: - post: - deprecated: false - operationId: SendMessage - requestBody: - content: - application/json: - example: - recipient_type: individual - text: - body: - to: "{{Recipient-WA-ID}}" - type: text - schema: - $ref: "#/components/schemas/Send-Message-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Message-Response" - description: "" - summary: Send-Message - tags: - - Messages - "/messages/{MessageID}": - put: - deprecated: false - operationId: MarkMessageAsRead - parameters: - - description: Message ID from Webhook - in: path - name: MessageID - required: true - schema: - type: string - requestBody: - content: - application/json: - example: - status: read - schema: - $ref: "#/components/schemas/Mark-Message-As-Read-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Mark-Message-As-Read - tags: - - Messages - /metrics: - get: - deprecated: false - operationId: GetMetrics - parameters: - - description: "" - example: prometheus - in: query - name: format - schema: - type: string - responses: - "200": - content: - application/json: - schema: - type: object - text/plain: - schema: - type: string - description: "" - summary: Get-Metrics (since v2.21.3) - tags: - - Health - /settings/account/two-step: - delete: - deprecated: false - operationId: DisableTwoStep - responses: - "200": - description: "" - summary: Disable-Two-Step - tags: - - Two-Step Verification - post: - deprecated: false - operationId: EnableTwoStep - requestBody: - content: - application/json: - example: - pin: - schema: - $ref: "#/components/schemas/Enable-Two-Step-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Enable-Two-Step - tags: - - Two-Step Verification - /settings/application: - delete: - deprecated: false - operationId: ResetApplicationSettings - responses: - "200": - description: "" - summary: Reset-Application-Settings - tags: - - Application - get: - deprecated: false - operationId: GetApplicationSettings - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Application-Settings" - description: "" - summary: Get-Application-Settings - tags: - - Application - patch: - callbacks: - incomingWebhook: - "{$request.body#/webhooks.url}": - post: - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Webhook-Event" - responses: - "200": - description: OK - deprecated: false - description: If a field is not present in the request, no change is made to that setting. For example, if on_call_pager is not sent with the request, the existing configuration for on_call_pager is unchanged. - operationId: UpdateApplicationSettings - requestBody: - content: - application/json: - example: - webhooks: - url: - schema: - $ref: "#/components/schemas/Application-Settings" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Response" - description: "" - summary: Update-Application-Settings - tags: - - Application - /settings/application/media/providers: - get: - deprecated: false - operationId: GetMediaProviders - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Get-Media-Providers-Response" - description: "" - summary: Get-Media-Providers - tags: - - Application - post: - deprecated: false - operationId: UpdateMediaProviders - requestBody: - content: - application/json: - example: - - config: - bearer: - name: - type: www - schema: - description: "" - items: - $ref: "#/components/schemas/Media-Provider" - type: array - description: "" - required: true - responses: - "200": - description: "" - summary: Update-Media-Providers - tags: - - Application - "/settings/application/media/providers/{ProviderName}": - delete: - deprecated: false - operationId: DeleteMediaProviders - parameters: - - description: Provider Name - in: path - name: ProviderName - required: true - schema: - type: string - responses: - "200": - description: "" - summary: Delete-Media-Providers - tags: - - Application - /settings/backup: - post: - deprecated: false - operationId: BackupSettings - requestBody: - content: - application/json: - example: - password: - schema: - $ref: "#/components/schemas/Backup-Settings-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Backup-Settings-Response" - description: "" - summary: Backup-Settings - tags: - - Backup/Restore - /settings/business/profile: - get: - deprecated: false - operationId: GetBusinessProfile - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Get-Business-Profile-Response" - description: "" - summary: Get-Business-Profile - tags: - - Business Profile - post: - deprecated: false - operationId: updateBusinessProfile - requestBody: - content: - application/json: - example: - address: - description: - email: - vertical: - websites: - - https://www.whatsapp.com - - https://www.facebook.com - schema: - $ref: "#/components/schemas/Business-Profile" - description: "" - required: true - responses: - "200": - description: "" - summary: Update-Business-Profile - tags: - - Business Profile - /settings/profile/about: - get: - deprecated: false - operationId: GetProfileAbout - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Get-Profile-About-Response" - description: "" - summary: Get-Profile-About - tags: - - Profile - patch: - deprecated: false - operationId: UpdateProfileAbout - requestBody: - content: - application/json: - example: - text: - schema: - $ref: "#/components/schemas/Profile-About" - description: "" - required: true - responses: - "200": - description: "" - summary: Update-Profile-About - tags: - - Profile - /settings/profile/photo: - delete: - operationId: DeleteProfilePhoto - responses: - "200": - description: "" - summary: Delete-Profile-Photo - get: - deprecated: false - operationId: GetProfilePhoto - parameters: - - description: "" - example: link - in: query - name: format - schema: - type: string - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Get-Profile-Photo-Response" - image/jpeg: - schema: - format: binary - type: string - description: "" - summary: Get-Profile-Photo - tags: - - Profile - post: - deprecated: false - operationId: UpdateProfilePhoto - requestBody: - content: - multipart/form-data: - schema: - properties: - File: - format: binary - type: string - required: - - File - type: object - required: false - responses: - "200": - description: "" - summary: Update-Profile-Photo - tags: - - Profile - /settings/restore: - post: - deprecated: false - operationId: RestoreSettings - requestBody: - content: - application/json: - example: - data: - password: - schema: - $ref: "#/components/schemas/Restore-Settings-Request-Body" - description: "" - required: true - responses: - "200": - description: "" - summary: Restore-Settings - tags: - - Backup/Restore - /stats/app: - get: - deprecated: false - operationId: GetAppStats - parameters: - - description: "" - example: prometheus - in: query - name: format - schema: - type: string - responses: - "200": - content: - application/json: - schema: - type: object - text/plain: - schema: - type: string - description: "" - summary: Get-App-Stats - tags: - - Health - /stats/db: - get: - deprecated: false - operationId: GetDbStats - parameters: - - description: "" - example: prometheus - in: query - name: format - schema: - type: string - responses: - "200": - content: - application/json: - schema: - type: object - text/plain: - schema: - type: string - description: "" - summary: Get-DB-Stats - tags: - - Health - /support: - get: - deprecated: false - operationId: GetSupportInfo - responses: - "200": - content: - application/json: - schema: - type: object - description: "" - summary: Get-Support-Info - tags: - - Health - /users: - post: - deprecated: false - operationId: CreateUser - requestBody: - content: - application/json: - example: - password: "{{UserPassword}}" - username: "{{UserUsername}}" - schema: - $ref: "#/components/schemas/Create-User-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/User-Response" - description: "" - summary: Create-User - tags: - - Users - /users/login: - post: - deprecated: false - operationId: LoginUser - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/Login-Admin-Request-Body" - required: false - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/User-Login-Response" - description: OK - security: - - httpBasic: [] - summary: Login-User - tags: - - Users - /users/logout: - post: - deprecated: false - operationId: LogoutUser - responses: - "200": - description: "" - summary: Logout-User - tags: - - Users - "/users/{UserUsername}": - delete: - deprecated: false - operationId: DeleteUser - parameters: - - description: "" - explode: false - in: path - name: UserUsername - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/User-Response" - description: "" - summary: Delete-User - tags: - - Users - get: - deprecated: false - operationId: GetUser - parameters: - - description: "" - explode: false - in: path - name: UserUsername - required: true - schema: - type: string - style: simple - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/Detailed-User-Response" - description: "" - summary: Get-User - tags: - - Users - put: - deprecated: false - operationId: UpdateUser - parameters: - - description: "" - explode: false - in: path - name: UserUsername - required: true - schema: - type: string - style: simple - requestBody: - content: - application/json: - example: - password: - schema: - $ref: "#/components/schemas/Update-User-Request-Body" - description: "" - required: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/User-Response" - description: "" - summary: Update-User - tags: - - Users -components: - schemas: - Address: - example: - city: Menlo Park - country: United States - country_code: us - state: CA - street: 1 Hacker Way - type: HOME - zip: "94025" - properties: - city: - description: City name - type: string - country: - description: Full country name - type: string - country_code: - description: Two-letter country abbreviation - type: string - state: - description: State abbreviation - type: string - street: - description: Street number and name - type: string - type: - description: "Standard Values: HOME, WORK" - type: string - zip: - description: ZIP code - type: string - required: - - city - - country - - country_code - - state - - street - - type - - zip - title: Address - type: object - Application-Settings: - example: - callback_backoff_delay_ms: 3000 - callback_persist: true - max_callback_backoff_delay_ms: 900000 - media: - auto_download: - - image - - document - - audio - on_call_pager: - pass_through: false - sent_status: false - webhooks: - max_concurrent_requests: 12 - url: - properties: - callback_backoff_delay_ms: - default: "3000" - description: |- - Backoff delay for a failed callback in milliseconds - This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting. - type: string - callback_persist: - default: true - description: Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required. - type: boolean - heartbeat_interval: - default: 5 - description: "Multiconnect: Interval of the Master node monitoring of Coreapp nodes in seconds" - type: integer - max_callback_backoff_delay_ms: - default: "900000" - description: Maximum delay for a failed callback in milliseconds - type: string - media: - $ref: "#/components/schemas/Media" - on_call_pager: - description: Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages. - type: string - pass_through: - default: true - description: |- - When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted. - When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required. - type: boolean - sent_status: - default: false - description: Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification. - type: boolean - unhealthy_interval: - default: 30 - description: "Multiconnect: Maximum amount of seconds a Master node waits for a Coreapp node to respond to a heartbeat before considering it unhealthy and starting the failover process." - type: integer - webhooks: - $ref: "#/components/schemas/Webhooks" - title: Update-Application-Settings-Request-Body - type: object - Audio: - description: The media object containing audio - oneOf: - - $ref: "#/components/schemas/AudioById" - - $ref: "#/components/schemas/AudioByProvider" - title: Audio - type: object - AudioById: - example: - id: - properties: - id: - type: string - required: - - id - title: AudioById - type: object - AudioByProvider: - example: - link: - provider: - name: - properties: - password: - description: Used to encrypt backup data for security - type: string - required: - - password - title: Backup-Settings-Request - type: object - Backup-Settings-Response: - description: Save the data value as that will be used along with your password to restore the information. - example: - settings: - data: encrypted-backup-data - properties: - settings: - $ref: "#/components/schemas/Backup-Settings" - title: Root Type for Backup-Settings-Response - type: object - Basic: - description: "" - example: - password: your-password - username: your-username - properties: - password: - type: string - username: - type: string - title: Root Type for Basic - type: object - Business-Profile: - example: - address: - description: - email: - vertical: - websites: - - https://www.whatsapp.com - - https://www.facebook.com - properties: - address: - description: |- - Address of the business - Maximum of 256 characters - type: string - description: - description: |- - Description of the business - Maximum of 256 characters - type: string - email: - description: |- - Email address to contact the business - Maximum of 128 characters - type: string - vertical: - description: |- - Industry of the business - Maximum of 128 characters - type: string - websites: - description: |- - URLs associated with business (e.g., website, Facebook page, Instagram) - Maximum of 2 websites with a maximum of 256 characters each - items: - type: string - type: array - required: - - address - - description - - email - - vertical - - websites - title: Set-Business-Profile-Request - type: object - Business-Settings: - description: "" - example: - business: - profile: - address: new-business-address - description: business-description - email: new-business-email - vertical: business-industry - websites: - - website-1 - - website-2 - properties: - business: - $ref: "#/components/schemas/Business-Settings-Business" - title: Root Type for Business-Settings - type: object - Business-Settings-Business: - description: "" - example: - profile: - address: new-business-address - description: business-description - email: new-business-email - vertical: business-industry - websites: - - website-1 - - website-2 - properties: - profile: - $ref: "#/components/schemas/Business-Profile" - title: Root Type for Business-Settings-Business - type: object - Check-Contact: - description: "" - example: - input: +1 (516) 283-7151 - status: valid - wa_id: "15162837151" - properties: - input: - description: The value you sent in the contacts field of the JSON request. - type: string - status: - description: Status of the user. - enum: - - processing - - valid - - invalid - type: string - x-enum-descriptions: - - "processing: Input is still being processed." - - "valid: Input determined to be a valid WhatsApp user." - - "invalid: Input determined to not be a valid WhatsApp user or the phone number is in a bad format." - wa_id: - description: WhatsApp user identifier that can be used in other API calls. Only returned if the status is valid. - type: string - title: Check-Contact - type: object - Check-Contact-Request-Body: - example: - blocking: wait - contacts: - - "{{Recipient-WA-ID}}" - properties: - blocking: - default: no_wait - description: Blocking determines whether the request should wait for the processing to complete (synchronous) or not (asynchronous). - enum: - - no_wait - - wait - type: string - contacts: - description: Array of contact phone numbers. The numbers can be in any standard telephone number format. - items: - type: string - type: array - required: - - contacts - title: Check-Contact-Request - type: object - Check-Contact-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - contacts: - items: - $ref: "#/components/schemas/Check-Contact" - type: array - type: object - description: "" - example: - contacts: - - input: 1-631-555-1002 - status: processing - - input: "6315551003" - status: processing - - input: +54 9 11 5612-1008 - status: processing - - input: +1 (516) 283-7151 - status: valid - wa_id: "15162837151" - title: Check-Contact-Response - type: object - Check-Health-Response: - description: "" - example: - health: - your-hostname1:your-container-id1: - gateway_status: connected - role: primary_master - your-hostname2:your-container-id2: - gateway_status: disconnected - role: secondary_master - properties: - health: - oneOf: - - $ref: "#/components/schemas/Gateway-Status" - - additionalProperties: - $ref: "#/components/schemas/Gateway-Node-Status" - type: object - title: Root Type for Check-Health-Response - type: object - Config: - oneOf: - - $ref: "#/components/schemas/Config-Bearer" - - $ref: "#/components/schemas/Config-Basic" - title: Config - Config-Basic: - example: - basic: - password: your-password - username: your-username - properties: - basic: - $ref: "#/components/schemas/Basic" - title: Config - type: object - Config-Bearer: - example: - bearer: - properties: - bearer: - type: string - required: - - bearer - title: Config - type: object - Contact: - example: - addresses: - - city: Menlo Park - country: United States - country_code: us - state: CA - street: 1 Hacker Way - type: HOME - zip: "94025" - - city: Menlo Park - country: United States - country_code: us - state: CA - street: 200 Jefferson Dr - type: WORK - zip: "94025" - birthday: 2012-08-18 - emails: - - email: test@fb.com - type: WORK - - email: test@whatsapp.com - type: WORK - name: - first_name: John - formatted_name: John Smith - last_name: Smith - org: - company: WhatsApp - department: Design - title: Manager - phones: - - phone: +1 (940) 555-1234 - type: HOME - - phone: +1 (650) 555-1234 - type: WORK - wa_id: "16505551234" - urls: - - type: WORK - url: https://www.facebook.com - properties: - addresses: - description: Full contact address(es) - items: - $ref: "#/components/schemas/Address" - type: array - birthday: - description: YYYY-MM-DD formatted string - type: string - emails: - description: Contact email address(es) - items: - $ref: "#/components/schemas/Email" - type: array - ims: - description: "" - items: - type: string - type: array - name: - $ref: "#/components/schemas/Name" - org: - $ref: "#/components/schemas/Org" - phones: - description: Contact phone number(s) - items: - $ref: "#/components/schemas/Phone" - type: array - urls: - description: Contact URL(s) - items: - $ref: "#/components/schemas/Url" - type: array - title: Contact - type: object - Create-Group-Request-Body: - example: - subject: - properties: - subject: - type: string - required: - - subject - title: Create-Group-Request - type: object - Create-User-Request-Body: - example: - password: password - username: username - properties: - password: - description: username - type: string - username: - description: password - type: string - required: - - username - - password - title: Create-User-Request - type: object - Currency: - description: "" - example: - amount_1000: 100990 - currency_code: USD - properties: - amount_1000: - format: int32 - type: integer - currency_code: - type: string - required: - - amount_1000 - - currency_code - title: Currency - type: object - Date-Time-Component: - description: Date/time by component - example: - day_of_month: 25 - day_of_week: 5 - hour: 15 - minute: 33 - month: 2 - year: 1977 - properties: - day_of_month: - description: The day of month - format: int32 - type: integer - day_of_week: - description: Both strings and numbers are accepted. If different from the value derived from the date (if specified), use the derived value. - enum: - - "1" - - "2" - - "3" - - "4" - - "5" - - "6" - - "7" - format: int32 - type: integer - x-enum-descriptions: - - Monday - - Tuesday - - Wednesday - - Thursday - - Friday - - Saturday - - Sunday - x-enum-varnames: - - MONDAY - - TUESDAY - - WEDNESDAY - - THURSDAY - - FRIDAY - - SATURDAY - - SUNDAY - hour: - description: The hour - format: int32 - type: integer - minute: - description: The minute - format: int32 - type: integer - month: - description: The month - format: int32 - type: integer - year: - description: The year - format: int32 - type: integer - title: Date-Time-Component - type: object - Date-Time-Object: - description: The Whatsapp Business API Client will attempt to format the date/time based on a specified localization. - example: - component: - day_of_month: 25 - day_of_week: 5 - hour: 15 - minute: 33 - month: 2 - year: 1977 - properties: - component: - $ref: "#/components/schemas/Date-Time-Component" - unix_epoch: - $ref: "#/components/schemas/Date-Time-Unix-Epoch" - title: Date-Time - type: object - Date-Time-Unix-Epoch: - description: Date/time by Unix epoch - example: - timestamp: 123456789 - properties: - timestamp: - description: Epoch timestamp in seconds - format: int32 - type: integer - title: Date-Time-Unix-Epoch - type: object - Detailed-User-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - users: - items: - $ref: "#/components/schemas/Detailed-User-Response-Item" - type: array - type: object - description: "" - example: - users: - - ROLES: ROLE_USER - username: username - title: Root Type for Detailed-User-Response - type: object - Detailed-User-Response-Item: - description: "" - example: - ROLES: ROLE_USER - username: username - properties: - ROLES: - $ref: "#/components/schemas/User-Role" - username: - type: string - title: Root Type for Detailed-Response-Item - type: object - Document: - description: The media object containing a document - oneOf: - - $ref: "#/components/schemas/DocumentById" - - $ref: "#/components/schemas/DocumentByProvider" - title: Document - type: object - DocumentById: - example: - caption: - filename: - id: - properties: - caption: - type: string - filename: - type: string - id: - type: string - required: - - caption - - id - - filename - title: Document - type: object - DocumentByProvider: - example: - caption: - filename: - link: - provider: - name: - type: - properties: - email: - type: string - type: - type: string - required: - - email - - type - title: Email - type: object - Enable-Two-Step-Request-Body: - example: - pin: your-6-digit-pin - properties: - pin: - type: string - required: - - pin - title: Enable-Two-Step-Request - type: object - Error: - description: "" - example: - code: 1234 - details: optional-detailed-error-message - title: error-code-title - properties: - code: - description: See the https://developers.facebook.com/docs/whatsapp/api/errors for more information. - format: int32 - type: integer - details: - description: error detail - type: string - href: - description: location for error detail - type: string - title: - description: error title - type: string - title: Error - type: object - Gateway-Node-Status: - description: "" - example: - gateway_status: connected - role: coreapp - properties: - gateway_status: - type: string - role: - enum: - - primary_master - - secondary_master - - coreapp - type: string - title: Root Type for Gateway-Node-Status - type: object - Gateway-Status: - description: "" - enum: - - connected - - connecting - - disconnected - - uninitialized - - unregistered - type: string - Get-Business-Profile-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - settings: - $ref: "#/components/schemas/Business-Settings" - type: object - description: "" - example: - settings: - business: - profile: - address: new-business-address - description: business-description - email: new-business-email - vertical: business-industry - websites: - - website-1 - - website-2 - title: Root Type for Get-Business-Profile-Response - type: object - Get-Media-Providers-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - settings: - $ref: "#/components/schemas/Media-Provider-Settings" - type: object - description: "" - example: - settings: - application: - media: - providers: - - config: - basic: - password: your-password - username: your-username - name: your-first-provider - type: www - - config: - bearer: your-bearer-token - name: your-second-provider - type: www - title: Root Type for Get-Media-Providers-Response - type: object - Get-Profile-About-Response: - description: "" - example: - settings: - profile: - about: - text: your-profile-about-text - properties: - settings: - $ref: "#/components/schemas/Profile-About-Settings" - title: Root Type for Get-Profile-About-Response - type: object - Get-Profile-Photo-Response: - description: "" - example: - settings: - profile: - photo: - link: profile-photo-url - properties: - settings: - $ref: "#/components/schemas/Profile-Photo-Settings" - title: Root Type for Get-Profile-Photo-Response - type: object - Group: - description: "" - example: - creation_time: 123456789 - id: your-group-id - properties: - creation_time: - description: timestamp - format: int32 - type: integer - id: - type: string - title: Groups-Response-Item - type: object - Group-Admin-Request-Body: - example: - wa_ids: - - - properties: - wa_ids: - description: The WhatsApp IDs of the people to be added or removed as group admins - items: - type: string - type: array - required: - - wa_ids - title: Group-Admin-Request - type: object - Group-Info: - description: "" - example: - admins: - - whatsapp-id-1 - - whatsapp-id-2 - creation_time: 123456789 - creator: whatsapp-id-1 - participants: - - whatsapp-id-3 - - whatsapp-id-4 - - whatsapp-id-5 - subject: your-group-subject - properties: - admins: - description: |- - Group administrators - Lists IDs of the creator of the group and any administrators added - items: - type: string - type: array - creation_time: - description: Group creation time - format: int32 - type: integer - creator: - description: ID of the creator of this group - type: string - participants: - description: |- - Participants of the group - This is an array of all the IDs of the participants in the group. Initially, this will be the creator of the group. - items: - type: string - type: array - subject: - description: Subject of the group - type: string - title: Group-Response-Item - type: object - Group-Invite: - description: "" - example: - link: group-invite-link - properties: - link: - type: string - title: Group-Invite - type: object - Group-Invite-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - groups: - items: - $ref: "#/components/schemas/Group-Invite" - type: array - type: object - description: "" - example: - groups: - - link: group-invite-link - title: Group-Invite-Response - type: object - Group-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - groups: - items: - $ref: "#/components/schemas/Group-Info" - type: array - type: object - description: "" - example: - groups: - - admins: - - whatsapp-id-1 - - whatsapp-id-2 - creation_time: 123456789 - creator: whatsapp-id-1 - participants: - - whatsapp-id-3 - - whatsapp-id-4 - - whatsapp-id-5 - subject: your-group-subject - title: Group-Response - type: object - Groups-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - groups: - items: - $ref: "#/components/schemas/Group" - type: array - type: object - description: "" - example: - groups: - - creation_time: 123456789 - id: your-group-id - title: GroupsResponse - type: object - Hsm: - description: The containing element for the message content — Indicates that the message is highly structured. Parameters contained within provide the structure. - example: - element_name: hello_world - language: - code: en - policy: deterministic - localizable_params: - - default: "1234" - namespace: business_a_namespace - properties: - element_name: - description: The element name that indicates which template to use within the namespace - type: string - language: - $ref: "#/components/schemas/Language" - localizable_params: - description: This field is an array of values to apply to variables in the template - items: - $ref: "#/components/schemas/LocalizableParam" - type: array - namespace: - description: The namespace that will be used - type: string - required: - - namespace - - element_name - - language - - localizable_params - title: Hsm - type: object - Image: - description: The media object containing an image - oneOf: - - $ref: "#/components/schemas/ImageById" - - $ref: "#/components/schemas/ImageByProvider" - title: Image - type: object - ImageById: - example: - caption: - id: - properties: - caption: - type: string - id: - type: string - required: - - caption - - id - title: ImageById - type: object - ImageByProvider: - example: - caption: - link: - provider: - name: - properties: - currency: - $ref: "#/components/schemas/Currency" - date_time: - $ref: "#/components/schemas/Date-Time-Object" - default: - description: Default text if localization fails - type: string - required: - - default - title: LocalizableParam - type: object - Location: - example: - address: - latitude: - longitude: - name: - properties: - address: - description: Address of the location. Only displayed if name is present. - type: string - latitude: - description: Latitude of the location - type: string - longitude: - description: Longitude of the location - type: string - name: - description: Name of the location - type: string - required: - - longitude - - latitude - - name - - address - title: Location - type: object - Login-Admin-Request-Body: - example: - new_password: - properties: - new_password: - type: string - required: - - new_password - title: Login-Admin-Request - type: object - Mark-Message-As-Read-Request-Body: - example: - status: read - properties: - status: - default: read - type: string - required: - - status - title: Mark-Message-As-Read-Request - type: object - Media: - example: - auto_download: - - image - - document - - audio - properties: - auto_download: - description: An array specifying which types of media to automatically download. - items: - enum: - - audio - - document - - voice - - video - - image. - type: string - type: array - required: - - auto_download - title: Media - type: object - Media-Provider: - example: - config: - bearer: - name: - type: www - properties: - config: - $ref: "#/components/schemas/Config" - name: - description: The name for the provider - type: string - type: - description: The type of provider - type: string - title: Update-Media-Providers-Request - type: object - Media-Provider-Settings: - description: "" - example: - application: - media: - providers: - - config: - basic: - password: your-password - username: your-username - name: your-first-provider - type: www - - config: - bearer: your-bearer-token - name: your-second-provider - type: www - properties: - application: - $ref: "#/components/schemas/Media-Provider-Settings-Application" - title: Root Type for Settings - type: object - Media-Provider-Settings-Application: - description: "" - example: - media: - providers: - - config: - basic: - password: your-password - username: your-username - name: your-first-provider - type: www - - config: - bearer: your-bearer-token - name: your-second-provider - type: www - properties: - media: - $ref: "#/components/schemas/Media-Provider-Settings-Application-Media" - title: Root Type for Settings-Application - type: object - Media-Provider-Settings-Application-Media: - description: "" - example: - providers: - - config: - basic: - password: your-password - username: your-username - name: your-first-provider - type: www - - config: - bearer: your-bearer-token - name: your-second-provider - type: www - properties: - providers: - items: - $ref: "#/components/schemas/Media-Provider" - type: array - title: Root Type for Settings-Application-Media - type: object - Message: - description: "" - example: - id: gBEGkYiEB1VXAglK1ZEqA1YKPrU - properties: - id: - type: string - title: Message - type: object - Message-Context: - description: "" - example: - from: sender-wa-id-of-context-message - group_id: group-id-of-context-message - id: message-id-of-context-message - mentions: - - wa-id1 - - wa-id2 - properties: - from: - description: Sender Whatsapp id of context-message - type: string - group_id: - description: GroupId of context message - type: string - id: - description: message id - type: string - mentions: - description: Whats app ids - items: - type: string - type: array - title: Root Type for Message-Context - type: object - Message-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - messages: - items: - $ref: "#/components/schemas/Message" - type: array - type: object - description: "" - example: - messages: - - id: gBEGkYiEB1VXAglK1ZEqA1YKPrU - title: Message-Response - type: object - Message-Type: - default: text - description: type of the message - enum: - - audio - - contacts - - document - - hsm - - image - - location - - text - - video - - voice - - unknown - type: string - Meta: - description: Contains generic information such as WhatsApp Business API Client version. - example: - api_status: stable - version: whatsapp-business-api-client-version - properties: - api_status: - enum: - - deprecated - - experimental - - stable - type: string - version: - type: string - title: Meta - type: object - Name: - description: Full contact name - example: - first_name: John - formatted_name: John Smith - last_name: Smith - properties: - first_name: - description: First name - type: string - formatted_name: - description: Full name as it normally appears - type: string - last_name: - description: Last name - type: string - prefix: - description: Name preffix - type: string - suffix: - description: Name suffix - type: string - required: - - formatted_name - title: Name - type: object - Org: - description: Contact organization information - example: - company: WhatsApp - department: Design - title: Manager - properties: - company: - description: Name of the contact's company - type: string - department: - description: Name of the contact's department - type: string - title: - description: Contact's business title - type: string - required: - - company - title: Org - type: object - Phone: - example: - phone: +1 (650) 555-1234 - type: WORK - wa_id: "16505551234" - properties: - phone: - type: string - type: - description: "Standard Values: CELL, MAIN, IPHONE, HOME, WORK" - type: string - wa_id: - description: WhatsApp ID - type: string - title: Phone - type: object - Profile-About: - example: - text: - properties: - text: - description: |- - Text to display in your profile's About section - The max length for the string is 139 characters. - type: string - required: - - text - title: Set-Profile-About-Request - type: object - Profile-About-Settings: - description: "" - example: - profile: - about: - text: your-profile-about-text - properties: - profile: - $ref: "#/components/schemas/Profile-About-Settings-Profile" - title: Root Type for Profile-About-Settings - type: object - Profile-About-Settings-Profile: - description: "" - example: - about: - text: your-profile-about-text - properties: - about: - $ref: "#/components/schemas/Profile-About" - title: Root Type for About-XXX - type: object - Profile-Photo-Settings: - description: "" - example: - profile: - photo: - link: profile-photo-url - properties: - profile: - properties: - photo: - properties: - link: - type: string - type: object - type: object - title: Root Type for Profile-Photo-Settings - type: object - Profile-Photo-Settings-Profile: - description: "" - example: - photo: - link: profile-photo-url - properties: - photo: - $ref: "#/components/schemas/Profile-Photo-Settings-Profile-Photo" - title: Root Type for Profile-Photo-Settings-Profile - type: object - Profile-Photo-Settings-Profile-Photo: - description: "" - example: - link: profile-photo-url - properties: - link: - type: string - title: Root Type for Profile-Photo-Settings-Profile-Photo - type: object - Provider: - example: - name: - cert: - method: < sms | voice > - phone_number: - pin: - password: - properties: - data: - description: The data that was returned by the /v1/settings/backup API call - type: string - password: - description: The password you used in the /v1/settings/backup API call to encrypt the backup data - type: string - required: - - password - - data - title: Restore-Settings-Request - type: object - Send-Message-Request-Body: - example: - preview_url: true - recipient_type: individual - text: - body: your-text-message-content - to: "{whatsapp-id}" - type: text - properties: - audio: - $ref: "#/components/schemas/Audio" - contacts: - description: "" - items: - $ref: "#/components/schemas/Contact" - type: array - document: - $ref: "#/components/schemas/Document" - hsm: - $ref: "#/components/schemas/Hsm" - image: - $ref: "#/components/schemas/Image" - location: - $ref: "#/components/schemas/Location" - preview_url: - description: |- - Specifying preview_url in the request is optional when not including a URL in your message. - To include a URL preview, set preview_url to true in the message body and make sure the URL begins with http:// or https://. For more information, see the Sending URLs in Text Messages section. - type: boolean - recipient_type: - default: individual - description: |- - Determines whether the recipient is an individual or a group - Specifying recipient_type in the request is optional when the value is individual. - However, recipient_type is required when using group. If sending a text message to a group, see the Sending Group Messages documentation. - enum: - - individual - - group - type: string - text: - $ref: "#/components/schemas/Text" - to: - description: When recipient_type is individual, this field is the WhatsApp ID (phone number) returned from contacts endpoint. When recipient_type is group, this field is the WhatsApp group ID. - type: string - ttl: - type: object - type: - $ref: "#/components/schemas/Message-Type" - video: - $ref: "#/components/schemas/Video" - required: - - to - title: Send-Text-Message-Request - type: object - Set-Shards-Request-Body: - example: - cc: - phone_number: - pin: - shards: 32 - properties: - cc: - type: string - phone_number: - type: string - pin: - type: string - shards: - enum: - - "1" - - "2" - - "4" - - "8" - - "16" - - "32" - format: int32 - type: integer - required: - - cc - - phone_number - - shards - - pin - title: Set-Shards-Request - type: object - Text: - example: - body: - properties: - body: - type: string - required: - - body - title: Text - type: object - Update-Group-Info-Request-Body: - example: - subject: - properties: - subject: - type: string - required: - - subject - title: Update-Group-Info-Request - type: object - Update-User-Request-Body: - example: - password: New Password - properties: - password: - description: password - type: string - required: - - password - title: Update-User-Request - type: object - Upload-Media: - description: "" - example: - id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68 - properties: - id: - type: string - title: Root Type for Upload-Media - type: object - Upload-Media-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - media: - items: - $ref: "#/components/schemas/Upload-Media" - type: array - type: object - description: "" - example: - media: - - id: f043afd0-f0ae-4b9c-ab3d-696fb4c8cd68 - title: Root Type for Upload-Media-Response - type: object - Url: - description: "Standard Values: HOME, WORK" - example: - type: WORK - url: https://www.facebook.com - properties: - type: - description: "Standard Values: HOME, WORK" - type: string - url: - description: URL - type: string - title: Root Type for Url - type: object - User-Login-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - users: - items: - $ref: "#/components/schemas/User-Login-Response-Item" - type: array - type: object - description: "" - example: - users: - - expires_after: 2018-03-01 15:29:26+00:00 - token: eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo - title: UserLoginResponse - type: object - User-Login-Response-Item: - description: "" - example: - expires_after: 2018-03-01 15:29:26+00:00 - token: eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo - properties: - expires_after: - description: Token expiration timestamp. By default, this is 7 days. - format: date-time - type: string - token: - description: |- - Authentication token to be used for all other WhatsApp Business API calls. The token must be sent in the authorization header in the format: - Authorization: Bearer - type: string - title: UserLoginResponseItem - type: object - User-Response: - allOf: - - $ref: "#/components/schemas/Response" - - properties: - users: - items: - $ref: "#/components/schemas/User-Response-Item" - type: array - type: object - description: "" - example: - users: - - username: username - title: Root Type for User-Create-Response - type: object - User-Response-Item: - description: "" - example: - username: username - properties: - username: - type: string - title: Root Type for User-Create-Response-Item - type: object - User-Role: - description: "" - enum: - - ROLE_ADMIN - - ROLE_USER - type: string - Video: - description: The media object containing a video - oneOf: - - $ref: "#/components/schemas/VideoById" - - $ref: "#/components/schemas/VideoByProvider" - title: Video - type: object - VideoById: - example: - caption: - id: - properties: - caption: - type: string - id: - type: string - required: - - caption - - id - title: VideoById - type: object - VideoByProvider: - example: - caption: - link: - provider: - name: - properties: - max_concurrent_requests: - default: 6 - description: Configures the maximum number of inflight callback requests that are sent out. Can be set to 6 (default), 12, 18, or 24. - enum: - - "6" - - "12" - - "18" - - "24" - format: int32 - type: integer - url: - description: Inbound and outbound notifications are routed to this URL. A HTTPS-based endpoint is required; HTTP will not work. - type: string - title: Webhooks - type: object - securitySchemes: - bearerAuth: - bearerFormat: token - scheme: bearer - type: http - httpBasic: - scheme: basic - type: http