{
  "opencollection": "1.0.0",
  "info": {
    "name": "Oracle Cloud VMware Solution Byol API",
    "version": "20230701"
  },
  "items": [
    {
      "info": {
        "name": "byol",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists the BYOLs in the specified compartment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230701/byols",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment."
              },
              {
                "name": "byolId",
                "value": "",
                "type": "query",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose lifecycle state matches the given value."
              },
              {
                "name": "softwareType",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose softwareType matches the given value."
              },
              {
                "name": "availableUnitsGreaterThanOrEqualTo",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources whose availableUnits greater than or equal to the given value."
              },
              {
                "name": "displayName",
                "value": "",
                "type": "query",
                "description": "A filter to return only resources that match the given display name exactly."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\n`timeTermStart` is descending. Default order for `timeCreated` is descending. \nDefault order for `displayName` is ascending. The `displayName`\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n"
              }
            ]
          },
          "docs": "Lists the BYOLs in the specified compartment. The list can be\nfiltered by display name or availability domain.\n"
        },
        {
          "info": {
            "name": "Creates an Byol",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230701/byols",
            "headers": [
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an Oracle Cloud VMware Solution Bring-You-Own-License (BYOL).\n\nUse the [WorkRequest](#/en/vmware/20230701/WorkRequest/) operations to track the\ncreation of the BYOL.\n"
        },
        {
          "info": {
            "name": "Get BYOL",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://127.0.0.1/20230701/byols/:byolId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "byolId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              }
            ]
          },
          "docs": "Gets the specified BYOL's information."
        },
        {
          "info": {
            "name": "Updates the specified BYOL",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://127.0.0.1/20230701/byols/:byolId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "byolId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the specified BYOL.\n"
        },
        {
          "info": {
            "name": "Deletes the specified Byol",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://127.0.0.1/20230701/byols/:byolId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "byolId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              }
            ]
          },
          "docs": "Deletes the specified BYOL.\n"
        },
        {
          "info": {
            "name": "Moves an BYOL into a different compartment within the same tenancy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230701/byols/:byolId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "byolId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves an BYOL into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n"
        },
        {
          "info": {
            "name": "Retrieve realm-wide allocation status for a specified BYOL.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://127.0.0.1/20230701/byols/:byolId/actions/retrieveByolRealmAllocations",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "byolId",
                "value": "",
                "type": "path",
                "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the BYOL."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending.\n"
              }
            ]
          },
          "docs": "Retrieve realm-wide allocation status for a specified BYOL."
        }
      ]
    }
  ],
  "bundled": true
}