{"openapi":"3.0.0","info":{"description":"Hyperstack (Nexgen Cloud) Infrahub API connector — GPU/CPU virtual machines, Kubernetes clusters, volumes, snapshots, firewalls, floating IPs, and billing across CANADA-1/NORWAY-1/US-1 regions.","version":"v1"},"servers":[{"description":"Hyperstack (Nexgen Cloud) Infrahub API connector — GPU/CPU virtual machines, Kubernetes clusters, volumes, snapshots, firewalls, floating IPs, and billing across CANADA-1/NORWAY-1/US-1 regions.","url":"https://api.apirails.com/hyperstack"}],"paths":{"/api-key":{"get":{"tags":["API Key"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_API_Key","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/api-key"},"summary":"Retrieve API Keys","description":"Retrieve API Keys | Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/api-key/retrieve-api-key). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/api-key/generate":{"post":{"tags":["API Key"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Generate_API_Key","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/api-key/generate"},"summary":"Generate API Key","description":"Generate API Key | Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/api-key/generate-api-key). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"body.description (string field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true}}},"example":{"description":["string"],"name":["string"]}}}}}},"/api-key/{api_key_id}":{"delete":{"tags":["API Key"],"parameters":[{"name":"api_key_id","in":"path","description":"api_key_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_API_Key","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/api-key/{api_key_id}"},"summary":"Delete API Key","description":"Delete API Key | Delete a specified API key by including the ID of the API key in the path. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["API Key"],"parameters":[{"name":"api_key_id","in":"path","description":"api_key_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_API_Key","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/api-key/{api_key_id}"},"summary":"Update API Key","description":"Update API Key | Updates the name and optionally the description of a specified API key. Include the ID of the API key in the path and the new name and optional description in the body of the request. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"body.description (string field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true}}},"example":{"description":["string"],"name":["string"]}}}}}},"/auth/beta-access/requests":{"get":{"tags":["Beta Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_beta_access_status","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/beta-access/requests"},"summary":"Check the status of all beta access requests","description":"Check the status of all beta access requests | Check the status of all beta access requests. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Beta Access"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_beta_access_request","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/beta-access/requests"},"summary":"Create a new beta access request","description":"Create a new beta access request | Creates a new beta access request for the current user | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"metadata":{"type":"object","description":"Optional metadata for the request","properties":{}},"program":{"type":"string","description":"Name of the beta program","required":true}}},"example":{"metadata":[{}],"program":["string"]}}}}}},"/auth/beta-access/requests/{program}":{"get":{"tags":["Beta Access"],"parameters":[{"name":"program","in":"path","description":"program (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_beta_access_requests","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/beta-access/requests/{program}"},"summary":"Check the status of beta access requests","description":"Check the status of beta access requests | Check the status of a particular beta access requests. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/email/opt-out":{"get":{"tags":["Email Preferences"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_email_preferences_for_a_user","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/email/opt-out"},"summary":"Get all email preferences for the authenticated user","description":"Get all email preferences for the authenticated user | Returns all email categories with the user's opt-in status. Categories without an explicit preference default to opted_in=true. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"put":{"tags":["Email Preferences"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Toggle_all_optional_email_preferences_for_the_user","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/email/opt-out"},"summary":"Toggle all optional email preferences for the authenticated user","description":"Toggle all optional email preferences for the authenticated user | Sets opted_in to the given value for every non-required, non-deleted email category. Required categories are not affected. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"opted_in":{"type":"boolean","description":"Set opted_in status","required":true,"enum":[true,false]}}},"example":{"opted_in":[false]}}}}}},"/auth/email/opt-out/{slug}":{"put":{"tags":["Email Preferences"],"parameters":[{"name":"slug","in":"path","description":"slug (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_email_preference_for_a_category_by_slug","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/email/opt-out/{slug}"},"summary":"Update email preference opted_in status for a category slug","description":"Update email preference opted_in status for a category slug | Updates the opted_in status for the given email category slug. If the slug belongs to a parent category (email_category_id is null), all non-deleted child categories are updated. If the slug belongs to a child category, only that category is updated. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"opted_in":{"type":"boolean","description":"Set opted_in status","required":true,"enum":[true,false]}}},"example":{"opted_in":[false]}}}}}},"/auth/invites":{"get":{"tags":["Invites"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Invites","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/invites"},"summary":"List Invites","description":"List Invites | Retrieve a list of email invitations from your organization. For additional information on listing invited users, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/invites/list-invites). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Invites"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Invite_User_to_Organization","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/invites"},"summary":"Invite User to Organization","description":"Invite User to Organization | Invites a user to join your organization. For additional information on inviting users to the organization, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/invites/invite-member). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email for sending invitation.","required":true}}},"example":{"email":["string"]}}}}}},"/auth/invites/{id}":{"delete":{"tags":["Invites"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_Invite","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/invites/{id}"},"summary":"Accept Invite","description":"Accept Invite | Deletes an invitation for a user to join your organization. For additional information on deleting an invitation, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/invites/delete-invite). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/auth/invites/{id}/accept":{"get":{"tags":["Invites"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Accept_Invite","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/invites/{id}/accept"},"summary":"Accept Invite (GET invites/)","description":"Accept Invite | Accept an invitation for a user to join your organization. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/me":{"get":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#RetrieveAuthenticatedUserDetails","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/me"},"summary":"Retrieve Authenticated User Details","description":"Retrieve Authenticated User Details | Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/auth). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/me/mfa":{"get":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_User_MFA_Status","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/me/mfa"},"summary":"Get MFA status for authenticated user","description":"Get MFA status for authenticated user | Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/me/mfa/disable":{"post":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Disable_MFA","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/me/mfa/disable"},"summary":"Disable_MFA","description":"Disable_MFA | Disable Multi-Factor Authentication (MFA) for the currently authenticated user. This endpoint is used to turn off MFA. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/auth/me/organizations":{"get":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_User_Organizations","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/me/organizations"},"summary":"Get User Organizations","description":"Get User Organizations | Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/organizations":{"get":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Retrieve_Organization_Information","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/organizations"},"summary":"Retrieve Organization Information","description":"Retrieve Organization Information | Retrieves detailed information about your organization, including current credit, threshold, number of instances, and number of volumes. For additional information on organizations, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/retrieve-org-details). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/organizations/remove-member":{"post":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Remove_Organization_Member","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/organizations/remove-member"},"summary":"Remove Organization Member","description":"Remove Organization Member | Removes a member from your organization. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/remove-member). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email of the user to be removed.","required":true}}},"example":{"email":["string"]}}}}}},"/auth/organizations/update":{"put":{"tags":["Organizations"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_Organization_Information","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/organizations/update"},"summary":"Update Organization Information","description":"Update Organization Information | Updates the name of the organization. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/organization/update-org-name). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The new name for the organition","required":true}}},"example":{"name":["string"]}}}}}},"/auth/partner-config":{"get":{"tags":["Partner Config"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_partner_config","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/partner-config"},"summary":"Get partner config","description":"Get partner config | Fetch the customised customer configuration for Hyperstack. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/partner-config/docs":{"get":{"tags":["Partner Config"],"parameters":[{"name":"domain","in":"query","description":"The domain to look up the partner config for.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_partner_config_by_domain","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/partner-config/docs"},"summary":"Get_partner_config_by_domain","description":"Get_partner_config_by_domain | Fetch the partner config for a given domain. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/permissions":{"get":{"tags":["Permissions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Permissions","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/permissions"},"summary":"List Permissions","description":"List Permissions | Retrieves a list of permissions that users can be granted to access a particular resource action. For additional information on permissions, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/permission/permissions). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/policies":{"get":{"tags":["Policies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Policies","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/policies"},"summary":"List Policies","description":"List Policies | Retrieves a list of policies available for addition to RBAC roles. For additional information on policies, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/policies). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/roles":{"get":{"tags":["RBAC Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_RBAC_Roles","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/roles"},"summary":"List RBAC Roles","description":"List RBAC Roles | Retrieves a list of RBAC roles that can be assigned to the users within an organization. For additional information on RBAC roles, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/list-rbac-roles). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["RBAC Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_RBAC_Role","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/roles"},"summary":"Create RBAC Role","description":"Create RBAC Role | Creates an RBAC role that can be assigned to users, granting them access to specific resource actions. Provide the configuration of the RBAC role, including its name, description, and list of permissions and policy IDs in the request body. For additional information on creating RBAC roles, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/create-rbac-role). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the role.","required":true},"name":{"type":"string","description":"Name of the RBAC role.","required":true},"permissions":{"type":"array","description":"body.permissions (array field from the documented request schema)","items":{"type":"number"}},"policies":{"type":"array","description":"body.policies (array field from the documented request schema)","items":{"type":"number"}}}},"example":{"description":["string"],"name":["string"],"permissions":[[0]],"policies":[[0]]}}}}}},"/auth/roles/{id}":{"delete":{"tags":["RBAC Roles"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_RBAC_Role","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/roles/{id}"},"summary":"Delete RBAC Role","description":"Delete RBAC Role | Deletes an RBAC role by providing its ID in the path. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/delete-rbac-role). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["RBAC Roles"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Retrieve_RBAC_Role_Details","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/roles/{id}"},"summary":"Retrieve RBAC Role Details","description":"Retrieve RBAC Role Details | Retrieves the details of a specified RBAC role by providing the RBAC role ID in the path. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/retrieve-rbac-details). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"put":{"tags":["RBAC Roles"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_RBAC_Role","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/roles/{id}"},"summary":"Update RBAC Role","description":"Update RBAC Role | Updates an RBAC role by providing the role ID in the path and the modified role configuration in the request body, including its name, description, and list of permissions and policy IDs. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/update-rbac-role). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the role.","required":true},"name":{"type":"string","description":"Name of the RBAC role.","required":true},"permissions":{"type":"array","description":"body.permissions (array field from the documented request schema)","items":{"type":"number"}},"policies":{"type":"array","description":"body.policies (array field from the documented request schema)","items":{"type":"number"}}}},"example":{"description":["string"],"name":["string"],"permissions":[[0]],"policies":[[0]]}}}}}},"/auth/token/change-org/{org_id}":{"get":{"tags":["Auth"],"parameters":[{"name":"org_id","in":"path","description":"org_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Change_Organization_for_Token","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/token/change-org/{org_id}"},"summary":"Change_Organization_for_Token","description":"Change_Organization_for_Token | Change the organization associated with the current token. This is useful for users who have access to multiple organizations. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/user-consent":{"get":{"tags":["User Consent"],"parameters":[{"name":"consent_type","in":"query","description":"Filter by consent type","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_All_Consents_for_a_User","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent"},"summary":"Get Consents for a User","description":"Get Consents for a User | Fetch all the recorded consents given from a User | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["User Consent"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Add_a_new_consent_for_a_User","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent"},"summary":"Add a new User consent","description":"Add a new User consent | Add a new consent given by the User | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"body.action (string field from the documented request schema)","required":true},"consent_method":{"type":"string","description":"body.consent_method (string field from the documented request schema)"},"consent_type":{"type":"string","description":"body.consent_type (string field from the documented request schema)","required":true},"consent_version":{"type":"string","description":"Version identifier. Defaults to the current version for the consent type"},"metadata":{"type":"object","description":"Consent-type-specific metadata","properties":{}}}},"example":{"action":["granted"],"consent_method":["web_checkbox"],"consent_type":["auto_top_up"],"consent_version":["string"],"metadata":[{}]}}}}}},"/auth/user-consent-events/{consent_type}/events":{"get":{"tags":["User Consent Events"],"parameters":[{"name":"consent_type","in":"path","description":"consent_type (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_consent_audit_events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent-events/{consent_type}/events"},"summary":"Get audit trail for a consent","description":"Get audit trail for a consent | Get all consent audit events | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/user-consent/templates":{"get":{"tags":["User Consent"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_all_consent_templates","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent/templates"},"summary":"Get all consent templates","description":"Get all consent templates | Returns current consent templates for all consent types | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/user-consent/templates/{consent_type}":{"get":{"tags":["User Consent"],"parameters":[{"name":"consent_type","in":"path","description":"consent_type (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_consent_template_by_type","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent/templates/{consent_type}"},"summary":"Get consent template for a specific type","description":"Get consent template for a specific type | Returns the current consent template for a specific consent type | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/user-consent/{consent_type}":{"patch":{"tags":["User Consent"],"parameters":[{"name":"consent_type","in":"path","description":"consent_type (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_a_consent_action_by_type","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/user-consent/{consent_type}"},"summary":"Grant or revoke an existing consent","description":"Grant or revoke an existing consent | Revoke or grant a consent to the User | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"body.action (string field from the documented request schema)","required":true},"consent_method":{"type":"string","description":"body.consent_method (string field from the documented request schema)"},"consent_version":{"type":"string","description":"Version identifier. Defaults to the current version for the consent type"},"metadata":{"type":"object","description":"Consent-type-specific metadata","properties":{}}}},"example":{"action":["granted"],"consent_method":["web_checkbox"],"consent_version":["string"],"metadata":[{}]}}}}}},"/auth/users/me/permissions":{"get":{"tags":["User Permissions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_My_User_Permissions","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/users/me/permissions"},"summary":"List My User Permissions","description":"List My User Permissions | Retrieves a list of permissions granted to your account. For additional information on your permissions, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/permission/list-my-permissions). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/users/{id}/permissions":{"get":{"tags":["User Permissions"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_User_Permissions","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/users/{id}/permissions"},"summary":"List User Permissions","description":"List User Permissions | Retrieves a list of permissions granted to a specific user within your organization. Provide the ID of the user in the path. For additional information on user permissions, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/permission/list-user-permissions). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/auth/users/{user_id}/assign-roles":{"put":{"tags":["Member Roles"],"parameters":[{"name":"user_id","in":"path","description":"user_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Assign_RBAC_Role_to_User","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/users/{user_id}/assign-roles"},"summary":"Assign RBAC Role","description":"Assign RBAC Role | Assigns a specific RBAC role to a user within your organization, granting them access to the resource actions permitted by the role. Provide the user ID in the path and the role ID in the request body. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/assign-rbac-role). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role_id":{"type":"number","description":"body.role_id (number field from the documented request schema)","required":true}}},"example":{"role_id":[0]}}}}}},"/auth/users/{user_id}/roles":{"delete":{"tags":["Member Roles"],"parameters":[{"name":"user_id","in":"path","description":"user_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Remove_RBAC_Role_From_User","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/auth/users/{user_id}/roles"},"summary":"Remove RBAC Role From User","description":"Remove RBAC Role From User | Removes an RBAC role from a user within your organization, revoking the resource permissions they had access to. Provide the user ID in the path. For additional information, [click here](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/rbac/manage-member-roles/revoke-rbac-role). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/billing/alive":{"get":{"tags":["Alive"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_alive","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/alive"},"summary":"GET: Alive","description":"GET: Alive | Retrieve the billing status of your account to ensure that it is active. An active billing status ensures uninterrupted service. For additional information [**click here**](None/docs/api-reference/billing-resources/alive/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/alive/doc":{"get":{"tags":["Alive"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_alive_doc","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/alive/doc"},"summary":"Get_alive_doc","description":"Get_alive_doc |  | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/auto-topup":{"delete":{"tags":["Auto Topup"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Disable_Auto_Top_Up","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/auto-topup"},"summary":"Disable auto top up, preventing any future automatic charges","description":"Disable auto top up, preventing any future automatic charges | Disable auto top up, preventing any future automatic charges | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Auto Topup"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Auto_Top_Up","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/auto-topup"},"summary":"Retrieve the current auto top up configuration and transaction history","description":"Retrieve the current auto top up configuration and transaction history | Retrieve the current auto top up configuration and transaction history | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Auto Topup"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Auto_Top_Up","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/auto-topup"},"summary":"Create an auto top up configuration and initiate Stripe setup","description":"Create an auto top up configuration and initiate Stripe setup | Create an auto top up configuration and initiate Stripe setup | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"threshold_amount":{"type":"number","description":"body.threshold_amount (number field from the documented request schema)","required":true},"topup_amount":{"type":"number","description":"body.topup_amount (number field from the documented request schema)","required":true}}},"example":{"threshold_amount":[0],"topup_amount":[0]}}}}},"put":{"tags":["Auto Topup"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_Auto_Top_Up","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/auto-topup"},"summary":"Update an existing active auto top up configuration","description":"Update an existing active auto top up configuration | Update an existing active auto top up configuration | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"threshold_amount":{"type":"number","description":"body.threshold_amount (number field from the documented request schema)","required":true},"topup_amount":{"type":"number","description":"body.topup_amount (number field from the documented request schema)","required":true}}},"example":{"threshold_amount":[0],"topup_amount":[0]}}}}}},"/billing/auto-topup/status":{"get":{"tags":["Auto Topup"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_auto_top-up_status","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/auto-topup/status"},"summary":"Get auto top-up status and configuration","description":"Get auto top-up status and configuration | Retrieves the current auto top-up configuration and status for your organization. Returns the status (active, disabled, pending_setup, or null if never configured), along with the threshold and top-up amounts. For additional information, [**click here**](None/docs/api-reference/billing-resources/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"graph","in":"query","description":"Set this value to \"true\" for getting graph value","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_User_Billing_History","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history"},"summary":"Retrieve Billing History for a specific Billing Cycle","description":"Retrieve Billing History for a specific Billing Cycle | User will receive billing history for the specified billing cycle. This data will include 'incurred_bill', 'non_discounted_bill', 'vm_cost', 'volume_cost' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/bucket":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Bucket_Billing_History","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/bucket"},"summary":"Retrieve Billing History of a Bucket for a specific Billing Cycle","description":"Retrieve Billing History of a Bucket for a specific Billing Cycle | User will receive billing history of buckets for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/bucket/{bucket_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"bucket_id","in":"path","description":"bucket_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Bucket_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/bucket/{bucket_id}"},"summary":"Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle","description":"Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle | Retrieve billing history of a specific Bucket for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/bucket/{bucket_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"bucket_id","in":"path","description":"bucket_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Buckets_billing_history_hourly_chart","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/bucket/{bucket_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Bucket for a specific billing cycle","description":"Retrieve hourly cost datapoints of a Specific Bucket for a specific billing cycle | User will receive hourly cost datapoints for a Bucket for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/cluster":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Clusters_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/cluster"},"summary":"Retrieve Billing History of Clusters for a specific Billing Cycle","description":"Retrieve Billing History of Clusters for a specific Billing Cycle | User will receive billing history of clusters for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/cluster/{cluster_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Cluster_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/cluster/{cluster_id}"},"summary":"Retrieve Billing History of a Specific Cluster for a specific Billing Cycle","description":"Retrieve Billing History of a Specific Cluster for a specific Billing Cycle | User will receive billing history of a specific Cluster for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'non_discounted_price_per_hour', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'usage_time_ACTIVE', 'usage_time_SHUTOFF', 'usage_time_HIBERNATED'. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/cluster/{cluster_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_cluster_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/cluster/{cluster_id}/graph"},"summary":"Retrieve hourly cost datapoints of a specific Cluster for a specific billing cycle","description":"Retrieve hourly cost datapoints of a specific Cluster for a specific billing cycle | User will receive hourly cost datapoints for a Cluster for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/contract":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by Contract \"Description\" or \"ID\"","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_billing_contract_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/contract"},"summary":"Retrieve Billing History of Contract for a specific Billing Cycle","description":"Retrieve Billing History of Contract for a specific Billing Cycle | User will receive billing history of contracts for the specified billing cycle. This data will include 'description', gpu_type','infrahub_id', 'status', 'incurred_bill', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/data_synthesis":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_data_synthesis_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/data_synthesis"},"summary":"Retrieve Billing History of data synthesis for a specific Billing Cycle","description":"Retrieve Billing History of data synthesis for a specific Billing Cycle | User will receive billing history of data_synthesis for the specified billing cycle. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/data_synthesis/{resource_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_data_synthesis_history_for_resource","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/data_synthesis/{resource_id}"},"summary":"Get_data_synthesis_history_for_resource","description":"Get_data_synthesis_history_for_resource | Retrieve billing history for a specific Data Synthesis resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/data_synthesis/{resource_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_data_synthesis_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/data_synthesis/{resource_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Data Synthesis for a specific","description":"Retrieve hourly cost datapoints of a Specific Data Synthesis for a specific | User will receive hourly cost datapoints for a data synthesis job for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.\nbilling cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/fine_tuning":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_fine-tuning_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/fine_tuning"},"summary":"Retrieve Billing History of model evaluation for a specific Billing Cycle","description":"Retrieve Billing History of model evaluation for a specific Billing Cycle | User will receive billing history of fine_tuning for the specified billing cycle. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/fine_tuning/{resource_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_resource_fine-tuning_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/fine_tuning/{resource_id}"},"summary":"Retrieve Billing History of a Specific Fine Tuning for a specific Billing Cycle","description":"Retrieve Billing History of a Specific Fine Tuning for a specific Billing Cycle | Retrieve billing history of a specific Fine tuning for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/fine_tuning/{resource_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_fine-tuning_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/fine_tuning/{resource_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Fine Tuning for a specific billing cycle","description":"Retrieve hourly cost datapoints of a Specific Fine Tuning for a specific billing cycle | User will receive hourly cost datapoints for a Fine Tunings for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/image_generation":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_image_generation_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/image_generation"},"summary":"Retrieve Billing History of image generation for a specific Billing Cycle","description":"Retrieve Billing History of image generation for a specific Billing Cycle | User will receive billing history of image_generation for the specified billing cycle. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/image_generation/{resource_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_image_generation_history_for_resource","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/image_generation/{resource_id}"},"summary":"Get_image_generation_history_for_resource","description":"Get_image_generation_history_for_resource | Retrieve billing history for a specific Image Generation resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/image_generation/{resource_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_image_generation_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/image_generation/{resource_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Image Generation for a specific","description":"Retrieve hourly cost datapoints of a Specific Image Generation for a specific | User will receive hourly cost datapoints for an image generation job for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.\nbilling cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/model_evaluation":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_model_evaluation_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/model_evaluation"},"summary":"Retrieve Billing History of model evaluation for a specific Billing Cycle (GET history/model_evaluation)","description":"Retrieve Billing History of model evaluation for a specific Billing Cycle | User will receive billing history of model_evaluation for the specified billing cycle. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/model_evaluation/{resource_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_resource_model_evaluation_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/model_evaluation/{resource_id}"},"summary":"Get_resource_model_evaluation_billing_history","description":"Get_resource_model_evaluation_billing_history | Retrieve billing history for a specific Model Evaluation resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/model_evaluation/{resource_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_model_evaluation_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/model_evaluation/{resource_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Model Evaluation for a specific","description":"Retrieve hourly cost datapoints of a Specific Model Evaluation for a specific | User will receive hourly cost datapoints for a model evaluation for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.\nbilling cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/serverless_inference":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_serverless_inference_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/serverless_inference"},"summary":"Retrieve Billing History of serverless inference for a specific Billing Cycle","description":"Retrieve Billing History of serverless inference for a specific Billing Cycle | User will receive billing history of serverless_inference for the specified billing cycle. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/serverless_inference/{resource_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_serverless_inferences_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/serverless_inference/{resource_id}"},"summary":"Get_serverless_inferences_billing_history","description":"Get_serverless_inferences_billing_history | Retrieve billing history for a specific Serverless Inference resource. Includes: 'resource_name', 'infrahub_id', 'base_model', 'base_model_display_name', 'lora_adapter', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'input_tokens', 'output_tokens', 'input_tokens_incurred_bill', 'input_tokens_non_discounted_bill', 'output_tokens_incurred_bill', 'output_tokens_non_discounted_bill' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/serverless_inference/{resource_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"resource_id","in":"path","description":"resource_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_serverless_inference_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/serverless_inference/{resource_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Serverless Inference for a specific","description":"Retrieve hourly cost datapoints of a Specific Serverless Inference for a specific | User will receive hourly cost datapoints for a serverless inference for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.\nbilling cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/snapshot":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_snapshot_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/snapshot"},"summary":"Retrieve Billing History of Snapshot for a specific Billing Cycle","description":"Retrieve Billing History of Snapshot for a specific Billing Cycle | User will receive billing history of snapshots for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/snapshot/{snapshot_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"snapshot_id","in":"path","description":"snapshot_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Datetime should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Snapshot_billing_history","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/snapshot/{snapshot_id}"},"summary":"Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle (GET snapshot/)","description":"Retrieve Billing History of a Specific Snapshot for a specific Billing Cycle | Retrieve billing history of a specific Snapshot for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/snapshot/{snapshot_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"snapshot_id","in":"path","description":"snapshot_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_snapshot_billing_history_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/snapshot/{snapshot_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle","description":"Retrieve hourly cost datapoints of a Specific Snapshot for a specific billing cycle | User will receive hourly cost datapoints for a Snapshot for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/virtual-machine":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_Billing_History","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/virtual-machine"},"summary":"Retrieve Billing History of Virtual Machine for a specific Billing Cycle","description":"Retrieve Billing History of Virtual Machine for a specific Billing Cycle | User will receive billing history of virtual machine for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/virtual-machine/{vm_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_Billing_Details","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/virtual-machine/{vm_id}"},"summary":"Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle","description":"Retrieve Billing History of a Specific Virtual Machine for a specific Billing Cycle | User will receive billing history of a specific Virtual Machine for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'non_discounted_price_per_hour', 'incurred_bill', 'non_discounted_bill', 'usage_time', 'usage_time_ACTIVE', 'usage_time_SHUTOFF', 'usage_time_HIBERNATED' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/virtual-machine/{vm_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_Billing_Graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/virtual-machine/{vm_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle","description":"Retrieve hourly cost datapoints of a Specific Virtual Machine for a specific billing cycle | User will receive hourly cost datapoints for a VM for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/volume":{"get":{"tags":["Billing"],"parameters":[{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search by resource \"Name\" or \"ID\"","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"Number of items to return per page","required":false,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Volume_Billing_History","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/volume"},"summary":"Retrieve Billing History of Volume for a specific Billing Cycle","description":"Retrieve Billing History of Volume for a specific Billing Cycle | User will receive billing history of volumes for thespecified billing cycle. This data will include 'resource_name', 'infrahub_id', 'status', 'incurred_bill', 'usage_time', 'price_per_hour' | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/volume/{volume_id}":{"get":{"tags":["Billing"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Volume_Billing_Details","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/volume/{volume_id}"},"summary":"Retrieve Billing History of a Specific Volume for a specific Billing Cycle","description":"Retrieve Billing History of a Specific Volume for a specific Billing Cycle | Retrieve billing history of a specific Volume for the specified billing cycle. This data will include 'resource_name', 'infrahub_id', 'price_per_hour', 'incurred_bill', 'usage_time', 'non_discounted_price_per_hour', 'non_discounted_bill'. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/history/volume/{volume_id}/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Volume_Billing_History_Graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/history/volume/{volume_id}/graph"},"summary":"Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle","description":"Retrieve hourly cost datapoints of a Specific Volume for a specific billing cycle | User will receive hourly cost datapoints for a Volume for a specified billing cycle. This data will include 'incurred_bill' graph datapoints. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/last-day-cost":{"get":{"tags":["Billing"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_last_day_cost","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/last-day-cost"},"summary":"GET: Last Day Cost","description":"GET: Last Day Cost | Retrieve the previous day's costs for instances, volumes, and clusters. Returns a breakdown of  the costs and the total cost for the last day. For additional information on Retrieve Previous Day Usage Costs, [**click here**](None/docs/api-reference/billing-resources/last-day-usage/) | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/threshold":{"get":{"tags":["Billing"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Org_notification_thresholds","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/threshold"},"summary":"GET: All Thresholds for Organization","description":"GET: All Thresholds for Organization | Retrieve all the notification thresholds for an organization. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/threshold/{threshold_id}":{"put":{"tags":["Billing"],"parameters":[{"name":"threshold_id","in":"path","description":"threshold_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_notification_threshold","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/threshold/{threshold_id}"},"summary":"Update: Subscribe or Unsubscribe Notification Threshold","description":"Update: Subscribe or Unsubscribe Notification Threshold | By default, you are subscribed to all the threshold values and you will be receiving the email notification for these default thresholds values. `false` indicates that the user will no longer receive notifications for this specific threshold, whereas `true` signifies that the user will receive notification emails. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subscribe":{"type":"boolean","description":"`false` indicates that the user will no longer receive notifications for this specific threshold, whereas `true` signifies that the user will receive notification emails.","required":true,"enum":[true,false]}}},"example":{"subscribe":[false]}}}}}},"/billing/billing/usage":{"get":{"tags":["Billing"],"parameters":[{"name":"deleted","in":"query","description":"`true` will return inactive resources and `false` will return active resources. By defualt(`deleted=false`)","required":false,"schema":{"type":"string","example":""}},{"name":"environment","in":"query","description":"Filter resources by environment ID or Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_usage","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/usage"},"summary":"GET: Billing usage","description":"GET: Billing usage | Retrieve active billing metrics for the organization's resources, including pricing, uptime, and total cost. Returns usage details for each active resource by defualt(`deleted=false` will return active resources). Additionally, adding `deleted=true` in query parameter will return inactive resources. For additional information on view usage costs for all resources, [**click here**](None/docs/billing/pricebook/) | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/virtual-machine/{vm_id}/billing-events":{"get":{"tags":["Billing"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_billing_events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/virtual-machine/{vm_id}/billing-events"},"summary":"Retrieve VM billing events history","description":"Retrieve VM billing events history | User will receive vm billing events history | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/virtual-machine/{vm_id}/sub-resource":{"get":{"tags":["Billing"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_sub-resource_costs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/virtual-machine/{vm_id}/sub-resource"},"summary":"Retrieve Total Costs and Non Discount Costs for Sub Resources","description":"Retrieve Total Costs and Non Discount Costs for Sub Resources | User will get total costs and non_discount costs of sub resources on a specific Virtual Machine for the specified billing cycle.\non a Specific VM for the Specified Billing Cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/virtual-machine/{vm_id}/sub-resource/graph":{"get":{"tags":["Billing"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_sub-resource_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/virtual-machine/{vm_id}/sub-resource/graph"},"summary":"Retrieve Sub-Resources Historical Cost datapoints of a Virtual","description":"Retrieve Sub-Resources Historical Cost datapoints of a Virtual | User will receive sub-resources historical cost datapoints for a VM sub resources for a specified billing cycle. This data will include 'incurred_bill' graph datapoints.\nMachine sub resources for a specific billing cycle | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/volume/{volume_id}/billing-events":{"get":{"tags":["Billing"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_volume_billing_events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/volume/{volume_id}/billing-events"},"summary":"Retrieve Volume billing events history","description":"Retrieve Volume billing events history | User will receive volume billing events history | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/billing/vouchers/redeem":{"post":{"tags":["Vouchers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Redeem_a_voucher","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/billing/vouchers/redeem"},"summary":"Redeem a voucher with a voucher_code","description":"Redeem a voucher with a voucher_code | Request to redeem a voucher with a voucher code. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"voucher_code":{"type":"string","description":"The code of the voucher you want to redeem.","required":true}}},"example":{"voucher_code":["string"]}}}}}},"/billing/payment/payment-details":{"get":{"tags":["Payment"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_payment_details","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/payment/payment-details"},"summary":"GET: View payment details","description":"GET: View payment details | Retrieves a list of all payments made within your [**organization**](/docs/rbac/organization) and their details, including the amount, payment status, and more. For additional information [**click here**](None/docs/api-reference/billing-resources/retrieve-payment-history/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/payment/payment-initiate":{"post":{"tags":["Payment"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Initiate_Payment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/payment/payment-initiate"},"summary":"POST: Initiate payment","description":"POST: Initiate payment | Creates a payment for a specified amount, adding credit to the balance of your [**organization**](/docs/rbac/organization). Include the `amount` in the body of the request to make a payment for the specified value in dollars. View a history of past payments by calling the [**Retrieve Payment History**](/docs/api-reference/billing-resources/retrieve-payment-history) API. For additional information [**click here**](None/docs/api-reference/billing-resources/create-payment). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"amount":{"type":"number","description":"body.amount (number field from the documented request schema)"}}},"example":{"amount":[0]}}}}}},"/billing/payment/receipt/{payment_id}":{"get":{"tags":["Payment"],"parameters":[{"name":"payment_id","in":"path","description":"payment_id (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_payment_receipt","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/payment/receipt/{payment_id}"},"summary":"Retrieve Payment Receipt","description":"Retrieve Payment Receipt | Retrieve the payment receipt from Stripe for a specific payment | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/user-credit/credit":{"get":{"tags":["Credit"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_user_credit","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/user-credit/credit"},"summary":"GET: View credit and threshold","description":"GET: View credit and threshold | Retrieves the current credit balance for your [**organization**](/docs/rbac/organization). Ensuring a positive credit balance allows you to create resources. However, for prepaid accounts, if the credit balance falls below $0, all associated resources will be temporarily suspended until a [**payment**](/docs/api-reference/billing-resources/create-payment) is made. For additional information, [**click here**](None/docs/api-reference/billing-resources/retrieve-credit-balance/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/user/countries":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_allowed_country_codes","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/user/countries"},"summary":"GET: Retrieve allowed country codes","description":"GET: Retrieve allowed country codes | Retrieve the list of allowed ISO 3166-1 alpha-2 country codes that can be used for billing information. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/billing/user/info":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_User_billing_info","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/user/info"},"summary":"GET: Retrieve billing info","description":"GET: Retrieve billing info | Retrieve the billing details associated with your user. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Add_user_billing_info","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/user/info"},"summary":"POST: Insert billing info","description":"POST: Insert billing info | Add billing details associated with your user in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"billing_address1":{"type":"string","description":"body.billing_address1 (string field from the documented request schema)"},"billing_address2":{"type":"string","description":"body.billing_address2 (string field from the documented request schema)"},"business":{"type":"boolean","description":"body.business (boolean field from the documented request schema)","required":true,"enum":[true,false]},"company_name":{"type":"string","description":"body.company_name (string field from the documented request schema)"},"country":{"type":"string","description":"body.country (string field from the documented request schema)","required":true},"email":{"type":"string","description":"body.email (string field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)"},"phone":{"type":"string","description":"body.phone (string field from the documented request schema)"},"state":{"type":"string","description":"body.state (string field from the documented request schema)"},"vat_number":{"type":"string","description":"body.vat_number (string field from the documented request schema)"},"zip_code":{"type":"string","description":"body.zip_code (string field from the documented request schema)","required":true}}},"example":{"billing_address1":["string"],"billing_address2":["string"],"business":[false],"company_name":["string"],"country":["string"],"email":["string"],"name":["string"],"phone":["string"],"state":["string"],"vat_number":["string"],"zip_code":["string"]}}}}},"put":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_user_billing_info","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/billing/user/info"},"summary":"PUT: Update billing info","description":"PUT: Update billing info | Update the billing information for your user in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"billing_address1":{"type":"string","description":"body.billing_address1 (string field from the documented request schema)"},"billing_address2":{"type":"string","description":"body.billing_address2 (string field from the documented request schema)"},"business":{"type":"boolean","description":"body.business (boolean field from the documented request schema)","required":true,"enum":[true,false]},"company_name":{"type":"string","description":"body.company_name (string field from the documented request schema)"},"country":{"type":"string","description":"body.country (string field from the documented request schema)","required":true},"email":{"type":"string","description":"body.email (string field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)"},"phone":{"type":"string","description":"body.phone (string field from the documented request schema)"},"state":{"type":"string","description":"body.state (string field from the documented request schema)"},"vat_number":{"type":"string","description":"body.vat_number (string field from the documented request schema)"},"zip_code":{"type":"string","description":"body.zip_code (string field from the documented request schema)","required":true}}},"example":{"billing_address1":["string"],"billing_address2":["string"],"business":[false],"company_name":["string"],"country":["string"],"email":["string"],"name":["string"],"phone":["string"],"state":["string"],"vat_number":["string"],"zip_code":["string"]}}}}}},"/core/clusters":{"get":{"tags":["Clusters"],"parameters":[{"name":"page","in":"query","description":"Page number for pagination","required":false,"schema":{"type":"number","example":""}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"type":"number","example":""}},{"name":"environment","in":"query","description":"Environment Filter","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search query to filter cluster by name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Clusters","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters"},"summary":"List Clusters","description":"List Clusters | List Clusters | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Clusters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Cluster","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters"},"summary":"Create Cluster","description":"Create Cluster | Create Cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deployment_mode":{"type":"string","description":"body.deployment_mode (string field from the documented request schema)"},"environment_name":{"type":"string","description":"body.environment_name (string field from the documented request schema)","required":true},"keypair_name":{"type":"string","description":"body.keypair_name (string field from the documented request schema)","required":true},"kubernetes_version":{"type":"string","description":"body.kubernetes_version (string field from the documented request schema)","required":true},"master_count":{"type":"number","description":"body.master_count (number field from the documented request schema)"},"master_flavor_name":{"type":"string","description":"body.master_flavor_name (string field from the documented request schema)","required":true},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true},"node_count":{"type":"number","description":"body.node_count (number field from the documented request schema)"},"node_flavor_name":{"type":"string","description":"body.node_flavor_name (string field from the documented request schema)"},"node_groups":{"type":"array","description":"body.node_groups (array field from the documented request schema)","items":{"type":"object","properties":{"count":{"type":"number","description":"body.node_groups.count (number field from the documented request schema)"},"firewall_ids":{"type":"array","description":"IDs of the firewalls to apply to all nodes in this node group"},"flavor_name":{"type":"string","description":"body.node_groups.flavor_name (string field from the documented request schema)","required":true},"max_count":{"type":"number","description":"body.node_groups.max_count (number field from the documented request schema)"},"min_count":{"type":"number","description":"body.node_groups.min_count (number field from the documented request schema)"},"name":{"type":"string","description":"body.node_groups.name (string field from the documented request schema)","required":true},"role":{"type":"string","description":"body.node_groups.role (string field from the documented request schema)","required":true}}}}}},"example":{"deployment_mode":["full"],"environment_name":["string"],"keypair_name":["string"],"kubernetes_version":["string"],"master_count":[0],"master_flavor_name":["string"],"name":["string"],"node_count":[0],"node_flavor_name":["string"],"node_groups":[[{"count":0,"firewall_ids":[0],"flavor_name":"string","max_count":0,"min_count":0,"name":"string","role":"worker"}]]}}}}}},"/core/clusters/master-flavors":{"get":{"tags":["Clusters"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Cluster_Master_Flavors","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/master-flavors"},"summary":"Get Cluster Master Flavors","description":"Get Cluster Master Flavors | Get Cluster Master Flavors | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/clusters/name-availability/{name}":{"get":{"tags":["Clusters"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Fetch_cluster_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/name-availability/{name}"},"summary":"Fetch cluster name availability","description":"Fetch cluster name availability | Check if a Cluster name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/clusters/versions":{"get":{"tags":["Clusters"],"parameters":[{"name":"region","in":"query","description":"Filter versions by region name (optional)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Cluster_Versions","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/versions"},"summary":"List Cluster Versions","description":"List Cluster Versions | Lists available Kubernetes versions, optionally filtered by region. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/clusters/{cluster_id}/events":{"get":{"tags":["Cluster Events"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_cluster_events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/events"},"summary":"Fetch all of a cluster events","description":"Fetch all of a cluster events | Fetch all of a cluster events | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/clusters/{cluster_id}/node-groups":{"get":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Node_Groups","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups"},"summary":"List node groups for a cluster","description":"List node groups for a cluster | List node groups for a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Node_Group","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups"},"summary":"Create a node group in a cluster","description":"Create a node group in a cluster | Create a node group in a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"count":{"type":"number","description":"body.count (number field from the documented request schema)"},"firewall_ids":{"type":"array","description":"IDs of the firewalls to apply to all nodes in this node group","items":{"type":"number"}},"flavor_name":{"type":"string","description":"body.flavor_name (string field from the documented request schema)","required":true},"max_count":{"type":"number","description":"body.max_count (number field from the documented request schema)"},"min_count":{"type":"number","description":"body.min_count (number field from the documented request schema)"},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true},"role":{"type":"string","description":"body.role (string field from the documented request schema)","required":true}}},"example":{"count":[0],"firewall_ids":[[0]],"flavor_name":["string"],"max_count":[0],"min_count":[0],"name":["string"],"role":["worker"]}}}}}},"/core/clusters/{cluster_id}/node-groups/{node_group_id}":{"delete":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"node_group_id","in":"path","description":"node_group_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_Node_Group","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups/{node_group_id}"},"summary":"Delete a node group","description":"Delete a node group | Delete a node group | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"node_group_id","in":"path","description":"node_group_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Node_Group","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups/{node_group_id}"},"summary":"Retrieve a node group in a cluster","description":"Retrieve a node group in a cluster | Retrieve a node group in a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"patch":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"node_group_id","in":"path","description":"node_group_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_Node_Group","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/node-groups/{node_group_id}"},"summary":"Update a node group in a cluster","description":"Update a node group in a cluster | Update a node group in a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"firewall_ids":{"type":"array","description":"IDs of the firewalls to apply to all nodes in this node group","items":{"type":"number"}},"max_count":{"type":"number","description":"body.max_count (number field from the documented request schema)"},"min_count":{"type":"number","description":"body.min_count (number field from the documented request schema)"}}},"example":{"firewall_ids":[[0]],"max_count":[0],"min_count":[0]}}}}}},"/core/clusters/{cluster_id}/nodes":{"get":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Cluster_Nodes","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/nodes"},"summary":"Get Cluster Nodes","description":"Get Cluster Nodes | Get Cluster Nodes | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Node","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/nodes"},"summary":"Create Node","description":"Create Node | Create Node | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"count":{"type":"number","description":"body.count (number field from the documented request schema)"},"node_group":{"type":"string","description":"body.node_group (string field from the documented request schema)"},"role":{"type":"string","description":"body.role (string field from the documented request schema)"}}},"example":{"count":[0],"node_group":["string"],"role":["worker"]}}}}}},"/core/clusters/{cluster_id}/nodes/delete":{"post":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_Cluster_Nodes","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/nodes/delete"},"summary":"Delete Multiple Cluster Nodes","description":"Delete Multiple Cluster Nodes | Delete Multiple Cluster Nodes | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ids":{"type":"array","description":"body.ids (array field from the documented request schema)","items":{"type":"number"}}}},"example":{"ids":[[0]]}}}}}},"/core/clusters/{cluster_id}/nodes/{node_id}":{"delete":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"node_id","in":"path","description":"node_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_Cluster_Node","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/nodes/{node_id}"},"summary":"Delete Cluster Node","description":"Delete Cluster Node | Delete Cluster Node | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/clusters/{cluster_id}/reconcile":{"post":{"tags":["Clusters"],"parameters":[{"name":"cluster_id","in":"path","description":"cluster_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Reconcile_cluster","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{cluster_id}/reconcile"},"summary":"Reconcile a cluster","description":"Reconcile a cluster | Reconcile a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/clusters/{id}":{"delete":{"tags":["Clusters"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_cluster","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{id}"},"summary":"Delete a cluster","description":"Delete a cluster | Delete a cluster | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Clusters"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Getting_Cluster_Detail","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/clusters/{id}"},"summary":"Getting Cluster Detail","description":"Getting Cluster Detail | Getting Cluster Detail | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/compliance":{"get":{"tags":["Compliance"],"parameters":[{"name":"gpu","in":"query","description":"This is for gpu model","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_compliance","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/compliance"},"summary":"Retrieve GPU compliance","description":"Retrieve GPU compliance | Returns a list of compliance objects each corresponding to available GPU models. These compliance objects contain minimum and maximum values for RAM in GB, number of vCPUs, and system disk capacity in GB. Use the optional `gpu` model parameter in the query string to filter responses by GPU model. For additional details on GPU compliance, [**click here**](https://docs.hyperstack.cloud/docs/hardware/flavors#adhering-to-gpu-compliance). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Compliance","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/compliance"},"summary":"Create compliance","description":"Create compliance | Create compliance | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_value":{"type":"number","description":"body.base_value (number field from the documented request schema)","required":true},"gpu_model":{"type":"string","description":"body.gpu_model (string field from the documented request schema)","required":true},"resource_type":{"type":"string","description":"body.resource_type (string field from the documented request schema)","required":true},"variation_max":{"type":"number","description":"body.variation_max (number field from the documented request schema)","required":true},"variation_min":{"type":"number","description":"body.variation_min (number field from the documented request schema)","required":true},"variation_unit":{"type":"number","description":"body.variation_unit (number field from the documented request schema)","required":true}}},"example":{"base_value":[0],"gpu_model":["string"],"resource_type":["string"],"variation_max":[0],"variation_min":[0],"variation_unit":[0]}}}}},"put":{"tags":["Compliance"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_compliance","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/compliance"},"summary":"Update a compliance","description":"Update a compliance | Update a compliance | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"base_value":{"type":"number","description":"body.base_value (number field from the documented request schema)","required":true},"gpu_model":{"type":"string","description":"body.gpu_model (string field from the documented request schema)","required":true},"resource_type":{"type":"string","description":"body.resource_type (string field from the documented request schema)","required":true},"variation_max":{"type":"number","description":"body.variation_max (number field from the documented request schema)","required":true},"variation_min":{"type":"number","description":"body.variation_min (number field from the documented request schema)","required":true},"variation_unit":{"type":"number","description":"body.variation_unit (number field from the documented request schema)","required":true}}},"example":{"base_value":[0],"gpu_model":["string"],"resource_type":["string"],"variation_max":[0],"variation_min":[0],"variation_unit":[0]}}}}}},"/core/compliance/{gpu_model}":{"delete":{"tags":["Compliance"],"parameters":[{"name":"gpu_model","in":"path","description":"gpu_model (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_compliance","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/compliance/{gpu_model}"},"summary":"Delete a compliance","description":"Delete a compliance | Delete a compliance | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/dashboard":{"get":{"tags":["Dashboard"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Dashboard","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/dashboard"},"summary":"Retrieve Dashboard","description":"Retrieve Dashboard | Returns hardware and pricing overview for your active resources, includingvirtual machines, containers, and volumes. For more details on the Dashboard feature, [**click here**](https://docs.hyperstack.cloud/docs/resource-management/dashboard/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/environments":{"get":{"tags":["Environment"],"parameters":[{"name":"page","in":"query","description":"Page Number","required":false,"schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Data Per Page","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search By ID or Name or Region","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_environments","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments"},"summary":"List environments","description":"List environments | Returns a list of your existing environments, providing the following details for each; environment ID, name, [**region**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/), and the date and time of creation. For more information on environments, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Environment"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_environment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments"},"summary":"Create environment","description":"Create environment | Creates an environment—a container to organize your resources, including SSH key pairs, virtual machines, and volumes. To create your environment, provide your desired environment name, and [**region**](https://docs.hyperstack.cloud/docs/resource-management/regions/) in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the environment being created.","required":true},"region":{"type":"string","description":"The geographic location of the data center where the environment is being created. To learn more about regions, [**click here**]({Config.INFRAHUB_DOCS_BASE}/docs/features/regions).","required":true}}},"example":{"name":["string"],"region":["string"]}}}}}},"/core/environments/name-availability/{name}":{"get":{"tags":["Environment"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Fetch_environment_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments/name-availability/{name}"},"summary":"Fetch environment name availability","description":"Fetch environment name availability | Check if a Environment name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/environments/{id}":{"delete":{"tags":["Environment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_environment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments/{id}"},"summary":"Delete environment","description":"Delete environment | Deletes an environment permanently. Provide the environment ID in the path to remove the specified environment. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Environment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_environment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments/{id}"},"summary":"Retrieve environment","description":"Retrieve environment | Retrieves details about a specific environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"put":{"tags":["Environment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_environment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments/{id}"},"summary":"Update environment","description":"Update environment | Updates the name of an existing environment. Provide the environment ID in the path and the new environment `name` in the request body to modify the specified environment. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The new name of the environment.","required":true}}},"example":{"name":["string"]}}}}}},"/core/environments/{id}/vm-quota":{"get":{"tags":["Environment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_environment_VM_quota","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/environments/{id}/vm-quota"},"summary":"Get environment VM quota","description":"Get environment VM quota | Retrieves VM quota information for a specific environment, including current VM count, maximum VMs allowed, available VMs, and percentage used in an environment before reaching the subnet IP limit. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/fip-detachment-exclusions/org/{org_id}":{"get":{"tags":["FIP Exclusions"],"parameters":[{"name":"org_id","in":"path","description":"org_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Check_if_Org_is_Excluded_from_Floating_IP_Detachment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/fip-detachment-exclusions/org/{org_id}"},"summary":"Check_if_Org_is_Excluded_from_Floating_IP_Detachment","description":"Check_if_Org_is_Excluded_from_Floating_IP_Detachment | is org excluded from floating ip detachment | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/firewalls":{"get":{"tags":["Firewalls"],"parameters":[{"name":"page","in":"query","description":"page (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}},{"name":"pageSize","in":"query","description":"pageSize (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"environment","in":"query","description":"Filter Environment ID or Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_existing_firewalls","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls"},"summary":"List firewalls","description":"List firewalls | Retrieves a list of existing firewalls and their details, including the security rules they contain and information about the virtual machines to which they are attached. For more information about the firewalls features offered by Infrahub, [**click here**](https://docs.hyperstack.cloud/docs/network-security/security-groups). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Firewalls"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_firewall","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls"},"summary":"Create firewall","description":"Create firewall | Creates a firewall to which firewall rules can be added. A firewall can be attached to one or more virtual machines to control inbound and outbound traffic. In the body of the request, include the name of the firewall, the ID of the environment within which the firewall will be created, and an optional description. To obtain the ID of the environment, make a request to the [**list environments**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/list-environments) endpoint. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Description of the firewall."},"environment_id":{"type":"number","description":"ID of the environment.","required":true},"name":{"type":"string","description":"Name of the firewall.","required":true}}},"example":{"description":["string"],"environment_id":[0],"name":["string"]}}}}}},"/core/firewalls/{firewall_id}/firewall-rules":{"post":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"firewall_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Add_rule_to_firewall","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls/{firewall_id}/firewall-rules"},"summary":"Add firewall rule to firewall","description":"Add firewall rule to firewall | Creates a [**firewall rule**](https://docs.hyperstack.cloud/docs/network-security/security-rules) and adds it to an existing firewall. Include the firewall ID in the path, and provide the firewall rule configuration in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"direction":{"type":"string","description":"The direction of traffic that the firewall rule applies to.","required":true},"ethertype":{"type":"string","description":"The Ethernet type associated with the rule.","required":true},"port_range_max":{"type":"number","description":"The maximum port number in the range of ports to be allowed by the firewall rule."},"port_range_min":{"type":"number","description":"The minimum port number in the range of ports to be allowed by the firewall rule."},"protocol":{"type":"string","description":"The network protocol associated with the rule. Call the [`GET /core/sg-rules-protocols`](https://infrahub-api-doc.nexgencloud.com/#get-/core/sg-rules-protocols) endpoint to retrieve a list of permitted network protocols.","required":true},"remote_ip_prefix":{"type":"string","description":"The IP address range that is allowed to access the specified port. Use \"0.0.0.0/0\" to allow any IP address.","required":true}}},"example":{"direction":["string"],"ethertype":["string"],"port_range_max":[0],"port_range_min":[0],"protocol":["any"],"remote_ip_prefix":["string"]}}}}}},"/core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id}":{"delete":{"tags":["Firewalls"],"parameters":[{"name":"firewall_id","in":"path","description":"firewall_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"firewall_rule_id","in":"path","description":"firewall_rule_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_rule_from_firewall","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id}"},"summary":"Delete firewall rules from firewall","description":"Delete firewall rules from firewall | Removes a firewall rule from firewall by providing the firewall ID and firewall rule ID in the path. For more information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/firewalls/remove-firewall-rule-from-firewall). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/firewalls/{firewall_id}/update-attachments":{"post":{"tags":["Firewall Attachment"],"parameters":[{"name":"firewall_id","in":"path","description":"firewall_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_firewall_to_VMs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls/{firewall_id}/update-attachments"},"summary":"Attach Firewalls to VMs","description":"Attach Firewalls to VMs | Attach a firewall to one or more virtual machines by providing the virtual machine IDs in the request body and the firewall ID in the path. For more information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/firewalls/attach-firewall-to-vms). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"vms":{"type":"array","description":"body.vms (array field from the documented request schema)","required":true,"items":{"type":"number"}}}},"example":{"vms":[[0]]}}}}}},"/core/firewalls/{id}":{"delete":{"tags":["Firewalls"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_existing_firewall","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls/{id}"},"summary":"Delete firewall","description":"Delete firewall | Deletes a firewall by specifying the firewall ID in the path. If the firewall is currently attached to a virtual machine, it must be detached before deletion. For more information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/firewalls/delete-firewall). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Firewalls"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_firewall","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/firewalls/{id}"},"summary":"Retrieve firewall details","description":"Retrieve firewall details | Retrieves the details of an existing firewall, including the security rules it contains and information about the virtual machines to which it is attached. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/flavors":{"get":{"tags":["Flavors"],"parameters":[{"name":"region","in":"query","description":"Region Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Flavors","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/flavors"},"summary":"List Flavors","description":"List Flavors | Returns a list of available virtual machine hardware configurations, known as**flavors**. You can specify a `region_name` in the query string of the request toretrieve flavors available only in the specified region; by default, it returnsflavors available in all regions. For more details on flavors,[**click here**](https://docs.hyperstack.cloud/docs/hardware/flavors). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/gpus":{"get":{"tags":["GPU"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_GPUs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/gpus"},"summary":"List GPUs","description":"List GPUs | Returns a list of all available GPUs that can be utilized in the creation of custom virtual machine configurations. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/image/name-availability/{name}":{"get":{"tags":["Images"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Fetch_Image_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/image/name-availability/{name}"},"summary":"Fetch name availability for Images","description":"Fetch name availability for Images | Check if an Image name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/images":{"get":{"tags":["Images"],"parameters":[{"name":"region","in":"query","description":"Region Name","required":false,"schema":{"type":"string","example":""}},{"name":"include_public","in":"query","description":"Flag to include public images in the response (true/false). Default is true.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"search","in":"query","description":"Search query to filter images by name","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"Page number for pagination","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Number of Images per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Images","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/images"},"summary":"List Images","description":"List Images | Returns a list of all available operating system (OS) images, providing details about each image's corresponding virtual machine operating system. You can include the optional `region` parameter in the query string of the request to specifically return OS images from the designated region. Additionally, use the `include_public` parameter to specify whether to include public images in the response. For more information onOS images, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/images). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/images/{id}":{"delete":{"tags":["Images"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_image","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/images/{id}"},"summary":"Delete an image","description":"Delete an image | Deletes an image permanently. Provide the image ID in the path to specify the image to be deleted. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Images"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"include_related_vms","in":"query","description":"include_related_vms (query parameter from the official API reference)","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Image","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/images/{id}"},"summary":"Get Private Image Details","description":"Get Private Image Details | Retrieve details of a specific image by providing the image ID. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/keypair/{id}":{"delete":{"tags":["Keypairs"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_key_pair","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/keypair/{id}"},"summary":"Delete key pair","description":"Delete key pair | Permanently deletes a specified key pair. Provide the key pair ID in the path to remove the designated key pair. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Keypairs"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_key_pair_name","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/keypair/{id}"},"summary":"Update key pair name","description":"Update key pair name | Updates the name of a specified key pair. Provide the key pair ID in the path, and include the new `name` in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The new key pair name.","required":true}}},"example":{"name":["string"]}}}}}},"/core/keypairs":{"get":{"tags":["Keypairs"],"parameters":[{"name":"page","in":"query","description":"Page Number","required":false,"schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Data Per Page","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_key_pairs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/keypairs"},"summary":"List key pairs","description":"List key pairs | Retrieves a list of your existing SSH key pairs, providing details for each. For more information on SSH key pairs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/keypairs/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Keypairs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Import_key_pair","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/keypairs"},"summary":"Import key pair","description":"Import key pair | Imports a new key pair for secure shell (SSH) access to your resources. Provide the key name, environment name, and public key in the request body. For more details on importing SSH key pairs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/keypairs/import-keypair). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"environment_name":{"type":"string","description":"The name of the environment where the key pair is being created.","required":true},"name":{"type":"string","description":"The name of the key pair that is being created.","required":true},"public_key":{"type":"string","description":"The public key that is being used to import an SSH key pair.","required":true}}},"example":{"environment_name":["string"],"name":["string"],"public_key":["string"]}}}}}},"/core/marketplace/deployments":{"get":{"tags":["Deployment"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Deployments","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/deployments"},"summary":"List Deployments","description":"List Deployments | List Deployments | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Deployment"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Start_Deployment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/deployments"},"summary":"Start Deployment","description":"Start Deployment | Start Deployment | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"body.description (string field from the documented request schema)","required":true},"name":{"type":"string","description":"body.name (string field from the documented request schema)","required":true},"template_id":{"type":"number","description":"body.template_id (number field from the documented request schema)","required":true},"variables":{"type":"object","description":"body.variables (object field from the documented request schema)","properties":{}}}},"example":{"description":["string"],"name":["string"],"template_id":[0],"variables":[{}]}}}}}},"/core/marketplace/deployments/{id}":{"delete":{"tags":["Deployment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_Deployment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/deployments/{id}"},"summary":"Delete Deployment","description":"Delete Deployment | Delete Deployment | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Deployment"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_deployment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/deployments/{id}"},"summary":"Details of Deployment by ID","description":"Details of Deployment by ID | Details of Deployment by ID | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/marketplace/templates":{"get":{"tags":["Templates"],"parameters":[{"name":"visibility","in":"query","description":"Specify the `visibility` status as either `public` or `private` to filter and retrieve templates with the desired visibility.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_templates","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/templates"},"summary":"List templates","description":"List templates | Returns a comprehensive list of templates, providing resource configuration details for each. Optionally, specify the `visibility` as `public` or `private` to retrieve templates with the desired visibility status. To learn more about the templates feature, [**click here**](https://docs.hyperstack.cloud/docs/features/templates#view-a-list-of-templates). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_template","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/templates"},"summary":"Create template","description":"Create template | Creates a resource template for deployment. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"YAML file is required","required":true},"description":{"type":"string","description":"description is required","required":true},"is_public":{"type":"string","description":"is_public is required","required":true},"name":{"type":"string","description":"name is required","required":true}}},"example":{"content":["string"],"description":["string"],"is_public":["string"],"name":["string"]}}}}}},"/core/marketplace/templates/{id}":{"delete":{"tags":["Templates"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_template","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/templates/{id}"},"summary":"Delete template","description":"Delete template | Permanently deletes a template. Supply the template ID in the path to delete the specified template. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Templates"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_template","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/templates/{id}"},"summary":"Retrieve template details","description":"Retrieve template details | Retrieves the resource configuration details for a specified template.Provide the template ID in the path to retrieve details for the specified template.For additional information on template configuration details,[**click here**](https://docs.hyperstack.cloud/docs/api-references/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_template","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/marketplace/templates/{id}"},"summary":"Update template","description":"Update template | Updates the details of a template. Modify the template name, description and/or`is_public` status to change the public/private visibility of the template. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"body.description (string field from the documented request schema)"},"is_public":{"type":"boolean","description":"body.is_public (boolean field from the documented request schema)","enum":[true,false]},"name":{"type":"string","description":"body.name (string field from the documented request schema)"}}},"example":{"description":["string"],"is_public":[false],"name":["string"]}}}}}},"/core/profiles":{"get":{"tags":["Profiles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_profiles","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/profiles"},"summary":"List profiles","description":"List profiles | Returns a list of your existing provisioning profiles, providing virtual machine configuration details for each. For additional information about profiles,[**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/provisioning-profiles#load-a-provisioning-profile). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Profiles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_profile","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/profiles"},"summary":"Create profile","description":"Create profile | Creates a provisioning profile to save the configuration of a virtual machinefor future use. Include the profile name, description, and virtual machine configuration details in the request body. For more information about virtual machine profiles,[**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/provisioning-profiles). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"data":{"type":"object","description":"The data object containing the configuration details of the virtual machine profile being created.","required":true,"properties":{}},"description":{"type":"string","description":"The optional description for the profile being created."},"name":{"type":"string","description":"The name of the profile being created.","required":true}}},"example":{"data":[{}],"description":["string"],"name":["string"]}}}}}},"/core/profiles/{id}":{"delete":{"tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_profile","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/profiles/{id}"},"summary":"Delete profile","description":"Delete profile | Permanently deletes a provisioning profile. Supply the profile ID in the path to delete the specified profile. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Profiles"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_profile","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/profiles/{id}"},"summary":"Retrieve profile details","description":"Retrieve profile details | Retrieves details for an existing provisioning profile by supplying the profile ID in the request path. For more information about profiles, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/provisioning-profiles). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/regions":{"get":{"tags":["Regions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Regions","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/regions"},"summary":"List Regions","description":"List Regions | Lists the currently available regions, each representing a distinct geographic  location housing a data center. For additional information on regions, [**click here**](https://docs.hyperstack.cloud/docs/resource-management/regions). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/sg-rules-protocols":{"get":{"tags":["Security Rules"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_firewall_rule_protocols","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/sg-rules-protocols"},"summary":"List firewall rule protocols","description":"List firewall rule protocols | Returns a list of all available protocols that can be used in the creation of firewall rules for your virtual machines. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/snapshots":{"get":{"tags":["Snapshots"],"parameters":[{"name":"page","in":"query","description":"Page Number","required":false,"schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Data Per Page","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search By Snapshot ID or Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_snapshots","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots"},"summary":"Retrieve list of snapshots with pagination","description":"Retrieve list of snapshots with pagination | Retrieves a list of snapshots, providing details such as snapshot name, timestamp, VM ID, and other relevant information. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/snapshots/name-availability/{name}":{"get":{"tags":["Snapshots"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Fetch_snapshot_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/name-availability/{name}"},"summary":"Fetch snapshot name availability","description":"Fetch snapshot name availability | Check if a Snapshot name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/snapshots/{id}":{"delete":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_snapshot","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/{id}"},"summary":"Delete snapshot","description":"Delete snapshot | Delete a snapshot. Provide the snapshot ID in the path to delete the specified snapshot. If the snapshot is connected with an image, that image will also bedeleted and the deleted image ID will be returned in the success message response. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_snapshot","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/{id}"},"summary":"Retrieve a snapshot","description":"Retrieve a snapshot | Retrieve a snapshot. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/snapshots/{id}/restore":{"post":{"tags":["Snapshots"],"parameters":[{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Restore_snapshot","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/{id}/restore"},"summary":"Restore a snapshot","description":"Restore a snapshot | Restore a snapshot. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contract_id":{"type":"number","description":"Contract ID to assign to the newly restored VM"},"new_vm_name":{"type":"string","description":"The name of the newly restored VM","required":true}}},"example":{"contract_id":[0],"new_vm_name":["string"]}}}}}},"/core/snapshots/{snapshot_id}/events":{"get":{"tags":["Snapshot Events"],"parameters":[{"name":"snapshot_id","in":"path","description":"snapshot_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Snapshot_Events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/{snapshot_id}/events"},"summary":"Fetch all events for a snapshot","description":"Fetch all events for a snapshot | Retrieves a list of all events for a Snapshot's history, which records actions performed on the specific snapshot. Requires the snapshot ID in the path. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/snapshots/{snapshot_id}/image":{"post":{"tags":["Snapshots"],"parameters":[{"name":"snapshot_id","in":"path","description":"snapshot_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_custom_image","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/snapshots/{snapshot_id}/image"},"summary":"Create an image from a snapshot","description":"Create an image from a snapshot | Create a new custom image from an existing snapshot.Requires a name and any labels for your new custom image. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"List of labels to attach to the image","items":{"type":"string"}},"name":{"type":"string","description":"Name for the new custom image","required":true}}},"example":{"labels":[["string"]],"name":["string"]}}}}}},"/core/stocks":{"get":{"tags":["Stock"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_GPU_stock","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/stocks"},"summary":"Retrieve GPU stocks","description":"Retrieve GPU stocks | Returns information on current and upcoming GPU availability, organized byregion and GPU model. For additional information on GPU stocks,[**click here**](https://docs.hyperstack.cloud/docs/hardware/gpu-stock-information). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/supported-keypairs":{"get":{"tags":["Keypairs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_supported_key_pair_types","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/supported-keypairs"},"summary":"List supported key pair types","description":"List supported key pair types | Retrieves the SSH public key types supported for import. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/user/resources/defaults":{"get":{"tags":["User Detail Choices"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_Default_Flavors_and_Images","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/user/resources/defaults"},"summary":"Retrieve Default Flavors and Images","description":"Retrieve Default Flavors and Images | Retrieves the default options for virtual machine deployment, including the default region, flavor, and image. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"page","in":"query","description":"page (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}},{"name":"pageSize","in":"query","description":"pageSize (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"environment","in":"query","description":"environment (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"exclude_firewalls","in":"query","description":"Comma-separated list of Security Group IDs to ignore instances attached","required":false,"schema":{"type":"array","example":""}},{"name":"exact_environment_match","in":"query","description":"Flag to filter environment by exact match instead of partial match","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_VMs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines"},"summary":"List virtual machines","description":"List virtual machines | Returns a list of your existing virtual machines, providing configuration details for each. The list is sorted by creation date, with the oldest virtual machines displayed first. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Virtual Machines"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_VMs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines"},"summary":"Create virtual machines","description":"Create virtual machines | Creates one or more virtual machines with the specified custom configuration and features provided in the request body. For more information about the virtual machine features offered by Infrahub, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/virtual-machine-features#create-a-virtual-machine-with-custom-features). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"assign_floating_ip":{"type":"boolean","description":"When this field is set to `true`, it attaches a [public IP address](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/floating-ip/) to the virtual machine, enabling internet accessibility.","enum":[true,false]},"callback_url":{"type":"string","description":"An optional URL where actions performed on the virtual machine will be sent. For additional information on event callbacks, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/callbacks-vms/)."},"count":{"type":"number","description":"The number of virtual machines to be created.","required":true},"create_bootable_volume":{"type":"boolean","description":"Indicates whether to create a bootable volume for the virtual machine. When set to `true`, a bootable volume will be created; the default value is `false`.","enum":[true,false]},"enable_port_randomization":{"type":"boolean","description":"Indicates whether to enable port randomization.This setting is only effective if 'assign_floating_ip' is true. Defaults to true.","enum":[true,false]},"enhanced_monitoring_enabled":{"type":"boolean","description":"When true, the Hyperstack VM Agent is opted in for this VM and metrics ingestion is allowed by the prom-gateway. The agent must still be installed on the VM (typically via user_data cloud-init).","enum":[true,false]},"environment_name":{"type":"string","description":"The name of the [environment](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/) in which the virtual machine is to be created.","required":true},"flavor":{"type":"object","description":"body.flavor (object field from the documented request schema)","properties":{"cpu":{"type":"number","description":"body.flavor.cpu (number field from the documented request schema)"},"disk":{"type":"number","description":"body.flavor.disk (number field from the documented request schema)"},"gpu":{"type":"string","description":"body.flavor.gpu (string field from the documented request schema)"},"gpu_count":{"type":"number","description":"body.flavor.gpu_count (number field from the documented request schema)"},"ram":{"type":"number","description":"body.flavor.ram (number field from the documented request schema)"}}},"flavor_name":{"type":"string","description":"The name of the GPU hardware configuration ([flavor](https://docs.hyperstack.cloud/docs/hardware/flavors)) for the virtual machines being created.","required":true},"image_name":{"type":"string","description":"The [operating system (OS) image](https://docs.hyperstack.cloud/docs/virtual-machines/images) name designated for installation on the virtual machine.It also accepts custom, private images, created from [existing snapshots](https://docs.hyperstack.cloud/docs/virtual-machines/custom-images)."},"key_name":{"type":"string","description":"The name of the existing SSH key pair to be used for secure access to the virtual machine. For additional information on SSH key pairs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/keypairs/).","required":true},"labels":{"type":"array","description":"body.labels (array field from the documented request schema)","items":{"type":"string"}},"name":{"type":"string","description":"The name of the virtual machine being created.","required":true},"profile":{"type":"object","description":"body.profile (object field from the documented request schema)","properties":{"description":{"type":"string","description":"body.profile.description (string field from the documented request schema)"},"name":{"type":"string","description":"body.profile.name (string field from the documented request schema)","required":true}}},"security_rules":{"type":"array","description":"body.security_rules (array field from the documented request schema)","items":{"type":"object","properties":{"direction":{"type":"string","description":"The direction of traffic that the firewall rule applies to.","required":true},"ethertype":{"type":"string","description":"The Ethernet type associated with the rule.","required":true},"protocol":{"type":"string","description":"The network protocol associated with the rule. Call the [`GET /core/sg-rules-protocols`](https://infrahub-api-doc.nexgencloud.com/#get-/core/sg-rules-protocols) endpoint to retrieve a list of permitted network protocols.","required":true},"remote_ip_prefix":{"type":"string","description":"The IP address range that is allowed to access the specified port. Use \"0.0.0.0/0\" to allow any IP address.","required":true},"port_range_min":{"type":"number","description":"body.security_rules.port_range_min (number field from the documented request schema)"},"port_range_max":{"type":"number","description":"body.security_rules.port_range_max (number field from the documented request schema)"}}}},"user_data":{"type":"string","description":"Optional initialization configuration commands to manage the configuration of a virtual machine at launch using cloud-init scripts. For more information about custom VM configuration using cloud-init, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/initialization-configuration)."},"volume_name":{"type":"string","description":"The names of the volume(s) to be attached to the virtual machine being created."}}},"example":{"assign_floating_ip":[false],"callback_url":["string"],"count":[0],"create_bootable_volume":[false],"enable_port_randomization":[true],"enhanced_monitoring_enabled":[false],"environment_name":["string"],"flavor":[{"disk":6,"gpu_count":1,"cpu":0,"gpu":"gpu","ram":5.962133916683182}],"flavor_name":["string"],"image_name":["string"],"key_name":["string"],"labels":[["string"]],"name":["string"],"profile":[{"description":"string","name":"string"}],"security_rules":[[{"direction":"string","ethertype":"string","protocol":"any","remote_ip_prefix":"string","port_range_min":0,"port_range_max":0}]],"user_data":["string"],"volume_name":["string"]}}}}}},"/core/virtual-machines/contract/{contract_id}/virtual-machines":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"contract_id","in":"path","description":"contract_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"page","in":"query","description":"Page Number","required":false,"schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Data Per Page","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"Search By Instance ID or Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_contract_VMs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/contract/{contract_id}/virtual-machines"},"summary":"Retrieve virtual machines associated with a contract","description":"Retrieve virtual machines associated with a contract | Retrieves a list of virtual machines associated with a contract, providing details such as virtual machine name, timestamp, flavor name, and other relevant information. Please provide the ID of the relevant contract in the path. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/name-availability/{name}":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"Nr of instances to handle (optional, default: 1)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Check_VM_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/name-availability/{name}"},"summary":"Fetch virtual machine name availability","description":"Fetch virtual machine name availability | Check if a Virtual Machine name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}":{"delete":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}"},"summary":"Delete virtual machine","description":"Delete virtual machine | Permanently deletes a virtual machine. Provide the virtual machine ID in the path to delete the specified virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}"},"summary":"Retrieve virtual machine details","description":"Retrieve virtual machine details | Retrieves the details of an existing virtual machine. Provide the virtual machine ID in the path, and Infrahub will return information about the corresponding VM. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/attach-callback":{"post":{"tags":["Callbacks"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_callback_to_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/attach-callback"},"summary":"Attach callback to virtual machine","description":"Attach callback to virtual machine | Creates a callback URL for a specified virtual machine, enabling the posting of action events executed on the virtual machine to the specified URL. Provide the callback URL in the request body and the ID of the virtual machine to which it is being attached in the path. For more details on virtual machine callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/callbacks-vms/attach-callback-vm). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"body.url (string field from the documented request schema)","required":true}}},"example":{"url":["string"]}}}}}},"/core/virtual-machines/{vm_id}/attach-firewalls":{"post":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_firewalls_to_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/attach-firewalls"},"summary":"Attach firewalls to a virtual machine","description":"Attach firewalls to a virtual machine | Attach firewalls to a virtual machine by providing the virtual machine ID in the path and the IDs of the firewalls in the request body; any firewalls not included will be detached. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"firewalls":{"type":"array","description":"Ids of the firewalls to be attached with a virtual machine.","required":true,"items":{"type":"number"}}}},"example":{"firewalls":[[0]]}}}}}},"/core/virtual-machines/{vm_id}/attach-floatingip":{"post":{"tags":["Floating IP"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_public_IP_to_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/attach-floatingip"},"summary":"Attach public IP to virtual machine","description":"Attach public IP to virtual machine | Initiates the creation of a public IP address and attaches it to an existing virtual machine, making it accessible through the internet. Include the virtual machine ID in the path to attach a public IP to the specified VM. For more information on public IP addresses, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/floating-ip/attach-floating-ip/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/virtual-machines/{vm_id}/attach-volumes":{"post":{"tags":["Volume Attachments"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_volumes_to_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/attach-volumes"},"summary":"Attach volumes to virtual machine","description":"Attach volumes to virtual machine | Attaches one or more volumes to an existing virtual machine, expanding its storage capacity by 2PB per attached volume. Include the VM ID in the path and the volume IDs in the request body to attach the specified volumes. For more detailson volume attachment, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/volumes/volume-attachment/attach-volumes/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"protected":{"type":"boolean","description":"body.protected (boolean field from the documented request schema)","enum":[true,false]},"volume_ids":{"type":"array","description":"body.volume_ids (array field from the documented request schema)","items":{"type":"number"}}}},"example":{"protected":[false],"volume_ids":[[0]]}}}}}},"/core/virtual-machines/{vm_id}/console/{job_id}":{"get":{"tags":["VNC URLs"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"job_id","in":"path","description":"job_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VNC_URL","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/console/{job_id}"},"summary":"Get VNC Console Link","description":"Get VNC Console Link | Retrieves the URL to access the VNC console for a specified virtual machine by providing the virtual machine ID and the job ID in the path. For more information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-vnc-url). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/delete-callback":{"delete":{"tags":["Callbacks"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_VM_callback","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/delete-callback"},"summary":"Delete virtual machine callback","description":"Delete virtual machine callback | Permanently deletes the callback URL associated with a specified virtual machine by providing the virtual machine ID in the request path. For additional information on virtual machine callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/callbacks-vms/delete-callback-vm). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/virtual-machines/{vm_id}/detach-floatingip":{"post":{"tags":["Floating IP"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Detach_public_IP_from_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/detach-floatingip"},"summary":"Detach public IP from virtual machine","description":"Detach public IP from virtual machine | Removes a public IP address from an existing virtual machine, disabling internet accessibility to the VM. Include the virtual machine ID in the path to detach the public IP from the specified VM. For more information on public IP addresses, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/public-ip). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/virtual-machines/{vm_id}/detach-volumes":{"post":{"tags":["Volume Attachments"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Detach_volumes_from_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/detach-volumes"},"summary":"Detach volumes from virtual machine","description":"Detach volumes from virtual machine | Detaches one or more volumes attached to an existing virtual machine. Include the VM ID in the path and volume IDs in the request body to detach the specified volumes from the virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"volume_ids":{"type":"array","description":"body.volume_ids (array field from the documented request schema)","items":{"type":"number"}}}},"example":{"volume_ids":[[0]]}}}}}},"/core/virtual-machines/{vm_id}/enhanced-metrics":{"patch":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Toggle_Enhanced_Metrics_for_a_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/enhanced-metrics"},"summary":"Enable or disable Enhanced Metrics for a virtual machine","description":"Enable or disable Enhanced Metrics for a virtual machine | Enable or disable the Hyperstack VM Agent (Enhanced Metrics) for an existing virtual machine. The agent itself must be installed/removed manually inside the VM — the response includes the install command when enabling. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"Set to true to opt this VM into Enhanced Metrics, false to opt out.","required":true,"enum":[true,false]}}},"example":{"enabled":[false]}}}}}},"/core/virtual-machines/{vm_id}/events":{"get":{"tags":["Virtual Machine Events"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_VM_events","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/events"},"summary":"List virtual machine events","description":"List virtual machine events | Retrieves a list of all events in a virtual machine's history, which records actions performed on the specified virtual machine. Include the virtual machine ID in the path to retrieve the history of events. For more details on virtual machine events history, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/vm-performance-metrics-and-events-history#events-history). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/hard-reboot":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Hard_reboot_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/hard-reboot"},"summary":"Hard reboot virtual machine","description":"Hard reboot virtual machine | Initiates a hard reboot for a virtual machine, simulating the process of unplugging and rebooting a physical machine. Provide the virtual machine ID in the path to execute a hard reboot for the specified virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/hibernate":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"retain_ip","in":"query","description":"false","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Hibernate_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/hibernate"},"summary":"Hibernate virtual machine","description":"Hibernate virtual machine | Initiates the hibernation of a virtual machine, saving its current state to disk before powering off. Provide the virtual machine ID in the path to specify the virtual machine to be hibernated. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/hibernate-restore":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Restore_VM_from_hibernation","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/hibernate-restore"},"summary":"Restore virtual machine from hibernation","description":"Restore virtual machine from hibernation | Resumes a virtual machine from hibernation, bringing it back to an active state. Provide the virtual machine ID that you want to restore from hibernation. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/label":{"put":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Add_VM_Label","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/label"},"summary":"Edit virtual machine labels","description":"Edit virtual machine labels | Adds one or more labels to an existing virtual machine. Provide the virtual machine ID in the path to add labels to the specified VM. For multiple labels, add a space between each label in the request body. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"array","description":"Multiple labels can be added by separating with spaces","items":{"type":"string"}}}},"example":{"labels":[["string"]]}}}}}},"/core/virtual-machines/{vm_id}/logs":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"request_id","in":"query","description":"request_id (query parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_Logs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/logs"},"summary":"Get virtual machine logs","description":"Get virtual machine logs | Retrieve console logs for a virtual machine | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Request_VM_Logs","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/logs"},"summary":"Request virtual machine logs","description":"Request virtual machine logs | Request console logs for a virtual machine | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"length":{"type":"number","description":"The amount of lines to fetch"}}},"example":{"length":[0]}}}}}},"/core/virtual-machines/{vm_id}/metrics":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"duration","in":"query","description":"duration (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["1h","2h","4h","6h","12h","1d","3d","7d","15d","30d"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_VM_metrics","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/metrics"},"summary":"Retrieve virtual machine performance metrics","description":"Retrieve virtual machine performance metrics | Retrieves performance metrics data for a virtual machine. Provide the virtual machine ID in the path to retrieve the following data for the specified virtual machine: CPU usage, memory usage (RAM), `network.in`, `network.out`, `disk.read`, and `disk.write`. The optional `duration` parameter can be used to specify the period for retrieving performance metrics; the default value will retrieve all available data. To learn more about virtual machine performance metrics, [**click here**](https://docs.hyperstack.cloud/docs/virtual-machines/vm-performance-metrics-and-events-history#performance-metrics). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/request-console":{"get":{"tags":["VNC URLs"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Request_VM_Console","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/request-console"},"summary":"Request Instance Console","description":"Request Instance Console | Retrieves the path of the VNC console for the given virtual machine ID by providing the virtual machine ID in the path. For more information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vnc-console/retrieve-console-path). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/resize":{"post":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Resize_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/resize"},"summary":"Resize virtual machine","description":"Resize virtual machine | Updates the hardware configuration for an existing virtual machine. Include the virtual machine ID in the path and provide the new configuration, referred to as a `flavor`, in the body of the request. For additional information resizing, [**click here**](https://docs.hyperstack.cloud/docs/hardware/flavors#modify-the-flavor-of-an-existing-virtual-machine). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"flavor":{"type":"object","description":"body.flavor (object field from the documented request schema)","properties":{"cpu":{"type":"number","description":"body.flavor.cpu (number field from the documented request schema)"},"disk":{"type":"number","description":"body.flavor.disk (number field from the documented request schema)"},"gpu":{"type":"string","description":"body.flavor.gpu (string field from the documented request schema)"},"gpu_count":{"type":"number","description":"body.flavor.gpu_count (number field from the documented request schema)"},"ram":{"type":"number","description":"body.flavor.ram (number field from the documented request schema)"}}},"flavor_name":{"type":"string","description":"body.flavor_name (string field from the documented request schema)"}}},"example":{"flavor":[{"disk":6,"gpu_count":1,"cpu":0,"gpu":"gpu","ram":5.962133916683182}],"flavor_name":["string"]}}}}}},"/core/virtual-machines/{vm_id}/sg-rules":{"post":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_firewall_rule_for_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/sg-rules"},"summary":"Add firewall rule to virtual machine","description":"Add firewall rule to virtual machine | Creates a firewall rule for a virtual machine. Include the virtual machine ID in the path, and provide the firewall rule configuration in the request body, as detailed below. For additional information on firewall rules, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/vm-firewall-rules/add-firewall-rule-to-vm). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"direction":{"type":"string","description":"The direction of traffic that the firewall rule applies to.","required":true},"ethertype":{"type":"string","description":"The Ethernet type associated with the rule.","required":true},"protocol":{"type":"string","description":"The network protocol associated with the rule. Call the [`GET /core/sg-rules-protocols`](https://infrahub-api-doc.nexgencloud.com/#get-/core/sg-rules-protocols) endpoint to retrieve a list of permitted network protocols.","required":true},"remote_ip_prefix":{"type":"string","description":"The IP address range that is allowed to access the specified port. Use \"0.0.0.0/0\" to allow any IP address.","required":true},"port_range_min":{"type":"number","description":"body.port_range_min (number field from the documented request schema)"},"port_range_max":{"type":"number","description":"body.port_range_max (number field from the documented request schema)"}}},"example":{"direction":["string"],"ethertype":["string"],"protocol":["any"],"remote_ip_prefix":["string"],"port_range_min":[0],"port_range_max":[0]}}}}}},"/core/virtual-machines/{vm_id}/sg-rules/{sg_rule_id}":{"delete":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"sg_rule_id","in":"path","description":"sg_rule_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_firewall_rule_for_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/sg-rules/{sg_rule_id}"},"summary":"Delete firewall rule from virtual machine","description":"Delete firewall rule from virtual machine | Deletes a firewall rule associated with a virtual machine. Provide the virtual machine ID and the firewall rule ID in the path to remove the specified rule from the specified virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/virtual-machines/{vm_id}/snapshots":{"post":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_Snapshot_for_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/snapshots"},"summary":"Create snapshot from a virtual machine","description":"Create snapshot from a virtual machine | Create snapshots of a virtual machine by providing the virtual machine ID in the path | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description","required":true},"labels":{"type":"array","description":"Labels associated with snapshot","items":{"type":"string"}},"name":{"type":"string","description":"Snapshot name","required":true}}},"example":{"description":["string"],"labels":[["string"]],"name":["string"]}}}}}},"/core/virtual-machines/{vm_id}/start":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Start_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/start"},"summary":"Start virtual machine","description":"Start virtual machine | Initiates the startup of a virtual machine. Provide the virtual machine ID in the path to initiate the starting of the specified virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/stop":{"get":{"tags":["Virtual Machines"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Stop_VM","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/stop"},"summary":"Stop virtual machine","description":"Stop virtual machine | Shuts down a virtual machine. Provide the virtual machine ID in the path to initiate the shutdown process for the specified virtual machine. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/virtual-machines/{vm_id}/update-callback":{"put":{"tags":["Callbacks"],"parameters":[{"name":"vm_id","in":"path","description":"vm_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_VM_callback","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/virtual-machines/{vm_id}/update-callback"},"summary":"Update virtual machine callback","description":"Update virtual machine callback | Updates the callback URL for a specified virtual machine. Provide the new callback URL in the request body, along with the ID of the associated virtual machine in the path. For additional information on virtual machine callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/virtual-machines/callbacks-vms). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"body.url (string field from the documented request schema)","required":true}}},"example":{"url":["string"]}}}}}},"/core/volume-attachments/{volume_attachment_id}":{"patch":{"tags":["Volume Attachments"],"parameters":[{"name":"volume_attachment_id","in":"path","description":"volume_attachment_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_volume_attachment","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volume-attachments/{volume_attachment_id}"},"summary":"Update a volume attachment","description":"Update a volume attachment | Update a volume attachment | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"protected":{"type":"boolean","description":"body.protected (boolean field from the documented request schema)","enum":[true,false]}}},"example":{"protected":[false]}}}}}},"/core/volume-types":{"get":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_volume_types","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volume-types"},"summary":"List volume types","description":"List volume types | Retrieves a list of available volume types that can be used in the creation of a new volume. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/volume/name-availability/{name}":{"get":{"tags":["Volumes"],"parameters":[{"name":"name","in":"path","description":"name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Fetch_volume_name_availability","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volume/name-availability/{name}"},"summary":"Fetch volume name availability","description":"Fetch volume name availability | Check if a Volume name is available | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/core/volumes":{"get":{"tags":["Volumes"],"parameters":[{"name":"page","in":"query","description":"Page Number","required":false,"schema":{"type":"string","example":""}},{"name":"pageSize","in":"query","description":"Data Per Page","required":false,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"environment","in":"query","description":"Filter Environment ID or Name","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_volumes","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes"},"summary":"List volumes","description":"List volumes | Returns a list of your existing volumes, providing details for each. For more information on volumes, [**click here**]({Config.INFRAHUB_DOCS_BASE}/docs/api-reference/core-resources/volumes/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Volumes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Create_volume","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes"},"summary":"Create volume","description":"Create volume | Creates a volume that can be attached to a virtual machine, expanding its storage capacity. Specify the volume type and custom configuration in the request body. For additional details on volumes, [**click here**]({Config.INFRAHUB_DOCS_BASE}/docs/api-reference/core-resources/volumes/create-volume). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"callback_url":{"type":"string","description":"A URL that can be attached to the volume you are creating. This `callback_url` will post any action events that occur to your volume to the provided URL."},"description":{"type":"string","description":"A brief description or comment about the volume."},"environment_name":{"type":"string","description":"The name of the [environment](https://docs.hyperstack.cloud/docs/api-reference/core-resources/environments/) within which the volume is being created.","required":true},"image_id":{"type":"number","description":"The ID of the operating system image that will be associated with the volume. By providing an `image_id` in the create volume request, you will create a bootable volume."},"name":{"type":"string","description":"The name of the volume being created.","required":true},"size":{"type":"number","description":"The size of the volume in GB. 1048576GB storage capacity per volume.","required":true},"volume_type":{"type":"string","description":"Specifies the type of volume being created, which determines the storage technology it will use. Call the [List volume types](https://infrahub-api-doc.nexgencloud.com/#get-/core/volumes) endpoint to retrieve a list of available volume model types.","required":true}}},"example":{"callback_url":["string"],"description":["string"],"environment_name":["string"],"image_id":[0],"name":["string"],"size":[0],"volume_type":["string"]}}}}}},"/core/volumes/{volume_id}":{"delete":{"tags":["Volumes"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_volume","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}"},"summary":"Delete volume","description":"Delete volume | Deletes a volume permanently. Provide the volume ID in the path to specify the volume to be deleted. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Volumes"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_Volume","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}"},"summary":"Fetch Volume Details","description":"Fetch Volume Details | Fetch volume details for specific volume. This endpoint returns id, name, volume size, volume type, status, description, image_id, os_image, created_at, updated_at etc. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"patch":{"tags":["Volumes"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_volume","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}"},"summary":"Update volume fields","description":"Update volume fields | Update volume properties. Currently supports updating the environment by providing 'environment_name'. The volume must not be attached to any instance when changing environments, and the target environment must be in the same region. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"environment_name":{"type":"string","description":"The name of the target environment to move the volume to. The target environment must be in the same region as the current environment.","required":true}}},"example":{"environment_name":["string"]}}}}}},"/core/volumes/{volume_id}/attach-callback":{"post":{"tags":["Callbacks"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Attach_callback_to_volume","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}/attach-callback"},"summary":"Attach callback to volume","description":"Attach callback to volume | Creates a callback URL for a specified volume, enabling the posting of action events executed on the volume to the specified URL. Provide the callback URL in the request body and the ID of the volume to which it is being attached in the path. For more details on volume callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/volumes/volume-callbacks/attach-callback-volume). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"body.url (string field from the documented request schema)","required":true}}},"example":{"url":["string"]}}}}}},"/core/volumes/{volume_id}/delete-callback":{"delete":{"tags":["Callbacks"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Delete_volume_callback","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}/delete-callback"},"summary":"Delete volume callback","description":"Delete volume callback | Permanently deletes the callback URL associated with a specified volume by providing the volume ID in the request path. For additional information on volume callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/volumes/volume-callbacks/delete-callback-volume). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/core/volumes/{volume_id}/update-callback":{"put":{"tags":["Callbacks"],"parameters":[{"name":"volume_id","in":"path","description":"volume_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Update_volume_callback","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/core/volumes/{volume_id}/update-callback"},"summary":"Update volume callback","description":"Update volume callback | Updates the callback URL for a specified volume. Provide the new callback URL in the request body, along with the ID of the associated volume in the path. For additional information on volume callback URLs, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/core-resources/volumes/volume-callbacks/update-callback-volume/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"url":{"type":"string","description":"body.url (string field from the documented request schema)","required":true}}},"example":{"url":["string"]}}}}}},"/object-storage/access-keys":{"get":{"tags":["Access Keys"],"parameters":[{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"page","in":"query","description":"page (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}},{"name":"page_size","in":"query","description":"page_size (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#listAccessKeysEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys"},"summary":"List access keys","description":"List access keys | List access keys | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]},"post":{"tags":["Access Keys"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#createAccessKeyEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys"},"summary":"Generate a new access key","description":"Generate a new access key | Generate a new access key | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"object","description":"body.description (object field from the documented request schema)","properties":{}},"region":{"type":"string","description":"body.region (string field from the documented request schema)","required":true}}},"example":{"description":[{}],"region":["CANADA-1"]}}}}}},"/object-storage/access-keys/{access_key_id}":{"delete":{"tags":["Access Keys"],"parameters":[{"name":"access_key_id","in":"path","description":"access_key_id (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#deleteAccessKeyEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/access-keys/{access_key_id}"},"summary":"Remove an existing access key","description":"Remove an existing access key | Remove an existing access key | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/object-storage/buckets":{"get":{"tags":["Buckets"],"parameters":[{"name":"search","in":"query","description":"search (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#listBucketsEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/buckets"},"summary":"List buckets","description":"List buckets | List buckets | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/object-storage/buckets/{bucket_name}":{"delete":{"tags":["Buckets"],"parameters":[{"name":"bucket_name","in":"path","description":"bucket_name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#deleteBucketEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/buckets/{bucket_name}"},"summary":"Delete a bucket","description":"Delete a bucket | Delete a bucket | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Buckets"],"parameters":[{"name":"bucket_name","in":"path","description":"bucket_name (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}},{"name":"region","in":"query","description":"region (query parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#retrieveBucketEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/buckets/{bucket_name}"},"summary":"Retrieve a bucket","description":"Retrieve a bucket | Retrieve a bucket | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/object-storage/healthz":{"get":{"tags":["Health"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#healthzEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/healthz"},"summary":"Healthcheck","description":"Healthcheck | Healthcheck | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/object-storage/regions":{"get":{"tags":["Regions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#listRegionsEndpoint","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/object-storage/regions"},"summary":"Get a list of supported regions","description":"Get a list of supported regions | Get a list of supported regions | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/pricebook":{"get":{"tags":["Pricebook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_pricebook","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/pricebook"},"summary":"Get_pricebook","description":"Get_pricebook | Retrieves the Infrahub Pricebook, detailing hourly running costs for all resources offered by Infrahub. For more information on Pricebook [**click here**](None/docs/api-reference/pricebook-resources/pricebook/). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/pricebook/calculate/resource/{resource_type}/{id}":{"get":{"tags":["Calculate"],"parameters":[{"name":"resource_type","in":"path","description":"resource_type (path parameter from the official API reference)","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Calculate_resource_billing_rate","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/pricebook/calculate/resource/{resource_type}/{id}"},"summary":"Retrieve Billing Rate for Resource","description":"Retrieve Billing Rate for Resource | Calculate the hourly billing rate of a specified resource by including the resource ID in the path. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/pricebook/contracts":{"get":{"tags":["Customer Contract"],"parameters":[{"name":"page","in":"query","description":"page (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per_page (query parameter from the official API reference)","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#List_customer_contracts","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/pricebook/contracts"},"summary":"List Contracts","description":"List Contracts | Retrieves a list of contracts and their details, including the terms of each contract and the discounts applied to all resources under each contract. Pagination can be controlled using the `page` and `per_page` query parameters. For additional information about contracts, click [**here**](None/docs/billing-and-payment/contracts). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/pricebook/contracts/{contract_id}":{"get":{"tags":["Customer Contract"],"parameters":[{"name":"contract_id","in":"path","description":"contract_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Retrieve_contract","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/pricebook/contracts/{contract_id}"},"summary":"Retrieve Contract Details","description":"Retrieve Contract Details | Retrieve details of a specific contract by providing the contract ID in the path. The endpoint returns the contract object along with its associated discount plans. For more information, [**click here**](None/docs/api-reference/pricebook-resources/retrieve-contract-details). | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}},"/pricebook/contracts/{contract_id}/gpu_allocation_graph":{"get":{"tags":["Customer Contract"],"parameters":[{"name":"contract_id","in":"path","description":"contract_id (path parameter from the official API reference)","required":true,"schema":{"type":"number","example":""}},{"name":"start_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}},{"name":"end_date","in":"query","description":"Date should be formatted in YYYY-MM-DDTHH:MM:SS","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://docs.hyperstack.cloud/docs/api-reference/introduction#Get_contract_GPU_allocation_graph","api_endpoint":"https://infrahub-api.nexgencloud.com/v1/pricebook/contracts/{contract_id}/gpu_allocation_graph"},"summary":"Retrieve GPU Allocation Graph for Contract","description":"Retrieve GPU Allocation Graph for Contract | Retrieve GPU allocation count graph for a specific contract by providing the contract ID in the path. The endpoint returns the GPU allocation count graph for the contract within the specified date range. | Source: official OpenAPI spec at https://raw.githubusercontent.com/NexGenCloud/hyperstack-sdk-go/main/api/openapi.yaml","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}