diff --git a/providers/src/nvidia/v00.00.00000/provider.yaml b/providers/src/nvidia/v00.00.00000/provider.yaml
new file mode 100644
index 00000000..04c8e43f
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/provider.yaml
@@ -0,0 +1,96 @@
+id: nvidia
+name: nvidia
+version: v00.00.00000
+providerServices:
+ catalog:
+ id: catalog:v00.00.00000
+ name: catalog
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/catalog.yaml
+ title: NVIDIA NGC Catalog
+ version: v00.00.00000
+ description: >-
+ The public NGC catalog: guest reads of models, resources, recipes, helm
+ charts, collections and generic artifacts, plus the GPU and cloud service
+ provider catalogs (no organization scope; public artifacts read without
+ credentials).
+ nvcf_deployments:
+ id: nvcf_deployments:v00.00.00000
+ name: nvcf_deployments
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/nvcf_deployments.yaml
+ title: NVIDIA Cloud Functions - Deployments
+ version: v00.00.00000
+ description: >-
+ NVCF deployments and GPU specifications, cluster groups and GPU inventory,
+ registry credentials and telemetry endpoints (source: the published NVCF
+ OpenAPI specification; served from api.ngc.nvidia.com).
+ nvcf_functions:
+ id: nvcf_functions:v00.00.00000
+ name: nvcf_functions
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/nvcf_functions.yaml
+ title: NVIDIA Cloud Functions - Functions
+ version: v00.00.00000
+ description: >-
+ NVCF functions and versions, function metadata, authorizations (function
+ sharing grants), secrets and rate limits (source: the published NVCF
+ OpenAPI specification; management operations served from
+ api.ngc.nvidia.com).
+ nvcf_invocation:
+ id: nvcf_invocation:v00.00.00000
+ name: nvcf_invocation
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/nvcf_invocation.yaml
+ title: NVIDIA Cloud Functions - Invocation
+ version: v00.00.00000
+ description: >-
+ NVCF HTTP-polling invocation (pexec and status), assets and invocation
+ assertion tokens (served from api.nvcf.nvidia.com).
+ nvcf_queues:
+ id: nvcf_queues:v00.00.00000
+ name: nvcf_queues
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/nvcf_queues.yaml
+ title: NVIDIA Cloud Functions - Queues
+ version: v00.00.00000
+ description: >-
+ NVCF request queue details per function and version, and queue position
+ per request (served from api.nvcf.nvidia.com).
+ orgs:
+ id: orgs:v00.00.00000
+ name: orgs
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/orgs.yaml
+ title: NVIDIA NGC Organizations
+ version: v00.00.00000
+ description: >-
+ NGC organizations, teams, users and team members, role grants, invitations
+ and the current user (source: the NGC API definition harvested from the
+ API explorer).
+ private_registry:
+ id: private_registry:v00.00.00000
+ name: private_registry
+ preferred: true
+ service:
+ $ref: nvidia/v00.00.00000/services/private_registry.yaml
+ title: NVIDIA NGC Private Registry
+ version: v00.00.00000
+ description: >-
+ Org-scoped artifact metadata in the NGC private registry: models,
+ resources, recipes, generic artifacts (helm charts, endpoints, blueprints,
+ agents, playbooks, APIs, skills), versions and files, collections, shares,
+ deployment parameters, encryption keys and workflows. Team-scoped twins
+ are mapped as *_by_team methods (source: the Private Artifacts (Models)
+ API definition, responses from the ngcsdk data classes).
+config:
+ auth:
+ type: bearer
+ credentialsenvvar: NGC_API_KEY
+ snake_case_aliases: true
diff --git a/providers/src/nvidia/v00.00.00000/services/catalog.yaml b/providers/src/nvidia/v00.00.00000/services/catalog.yaml
new file mode 100644
index 00000000..4a8b6df9
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/catalog.yaml
@@ -0,0 +1,9434 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA NGC Catalog
+ description: 'The public NGC catalog: guest reads of models, resources, recipes, helm charts, collections and generic artifacts, plus the GPU and cloud service provider catalogs (no organization scope; public artifacts read without credentials).'
+ version: 0.0.1-SNAPSHOT
+paths:
+ /v2/collections:
+ get:
+ description: List public collections
+ operationId: listPublicCollections
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public collections
+ tags:
+ - Collections
+ /v2/collections/{org_name}/{collection_name}:
+ get:
+ description: Get collection details in org as guest
+ operationId: getCollectionInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get collection in org as guest
+ tags:
+ - Collections
+ /v2/collections/{org_name}/{collection_name}/artifacts/{artifact_type}:
+ get:
+ description: List collection artifacts the user can access in the specified org as guest
+ operationId: listCollectionArtifactsInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collection artifacts in org as guest
+ tags:
+ - Collections
+ /v2/collections/{org_name}/{team_name}/{collection_name}:
+ get:
+ description: Get collection details in team as guest
+ operationId: getCollectionInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get collection in team as guest
+ tags:
+ - Collections
+ /v2/collections/{org_name}/{team_name}/{collection_name}/artifacts/{artifact_type}:
+ get:
+ description: List collection artifacts the user can access in the specified org and team as guest
+ operationId: listCollectionArtifactsInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collection artifacts in org and team as guest
+ tags:
+ - Collections
+ /v2/csps:
+ get:
+ description: List cloud service providers
+ operationId: listCloudServiceProviders
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ maximum: 5000
+ minimum: 1
+ type: integer
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ maximum: 10000
+ minimum: 0
+ type: integer
+ - description: Include disabled
+ in: query
+ name: include-disabled
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProviderListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List cloud service providers
+ tags:
+ - Cloud service providers
+ post:
+ description: Create cloud service provider
+ operationId: createCloudServiceProvider
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProviderCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProvider'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create cloud service provider
+ tags:
+ - Cloud service providers
+ parameters: []
+ /v2/csps/{artifact_type}/{org_name}/{artifact_name}/deployments/params:
+ get:
+ description: List public artifact deployment parameters in org
+ operationId: listPublicArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public artifact deployment parameters in org
+ tags:
+ - Artifact deployment parameters
+ /v2/csps/{artifact_type}/{org_name}/{artifact_name}/deployments/{csp_name}/params:
+ get:
+ description: Get public artifact deployment parameters details in org
+ operationId: getPublicArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get public artifact deployment parameters details in org
+ tags:
+ - Artifact deployment parameters
+ /v2/csps/{artifact_type}/{org_name}/{team_name}/{artifact_name}/deployments/params:
+ get:
+ description: List public artifact deployment parameters in team
+ operationId: listPublicArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public artifact deployment parameters in team
+ tags:
+ - Artifact deployment parameters
+ /v2/csps/{artifact_type}/{org_name}/{team_name}/{artifact_name}/deployments/{csp_name}/params:
+ get:
+ description: Get public artifact deployment parameters details in team
+ operationId: getPublicArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get public artifact deployment parameters details in team
+ tags:
+ - Artifact deployment parameters
+ /v2/csps/{csp_name}:
+ get:
+ description: Get cloud service provider details
+ operationId: getCloudServiceProviderDetails
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProvider'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get cloud service provider details
+ tags:
+ - Cloud service providers
+ patch:
+ description: Update cloud service provider
+ operationId: updateCloudServiceProvider
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProviderUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloudServiceProvider'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update cloud service provider
+ tags:
+ - Cloud service providers
+ delete:
+ description: Delete cloud service provider
+ operationId: deleteCloudServiceProvider
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete cloud service provider
+ tags:
+ - Cloud service providers
+ /v2/csps/{csp_name}/deployments/params:
+ get:
+ description: Get cloud service provider deployment parameters details
+ operationId: getCloudServiceProviderDeploymentParametersDetails
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get cloud service provider deployment parameters details
+ tags:
+ - Cloud service provider deployment parameters
+ post:
+ description: Create cloud service provider deployment parameters
+ operationId: createCloudServiceProviderDeploymentParameters
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create cloud service provider deployment parameters
+ tags:
+ - Cloud service provider deployment parameters
+ patch:
+ description: Update cloud service provider deployment parameters
+ operationId: updateCloudServiceProviderDeploymentParameters
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update cloud service provider deployment parameters
+ tags:
+ - Cloud service provider deployment parameters
+ delete:
+ description: Delete cloud service provider deployment parameters
+ operationId: deleteCloudServiceProviderDeploymentParameters
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete cloud service provider deployment parameters
+ tags:
+ - Cloud service provider deployment parameters
+ /v2/csps/{csp_name}/deployments/params/meta:
+ get:
+ description: Get cloud service provider deployment parameters meta details
+ operationId: getCloudServiceProviderDeploymentParametersMetaDetails
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersMeta'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get cloud service provider deployment parameters meta details
+ tags:
+ - Deployment parameters meta
+ post:
+ description: Create cloud service provider deployment parameters meta
+ operationId: createCloudServiceProviderDeploymentParametersMeta
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersMetaCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersMeta'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create cloud service provider deployment parameters meta
+ tags:
+ - Deployment parameters meta
+ patch:
+ description: Update cloud service provider deployment parameters meta
+ operationId: updateCloudServiceProviderDeploymentParametersMeta
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersMetaUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersMeta'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update cloud service provider deployment parameters meta
+ tags:
+ - Deployment parameters meta
+ delete:
+ description: Delete cloud service provider deployment parameters meta
+ operationId: deleteCloudServiceProviderDeploymentParametersMeta
+ parameters:
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete cloud service provider deployment parameters meta
+ tags:
+ - Deployment parameters meta
+ /v2/gpus:
+ get:
+ description: Get all GPU by PCI records
+ operationId: getGpus
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetGpusResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get all GPUs
+ tags:
+ - GpuByPci
+ parameters: []
+ /v2/gpus/pci-device-id/{pci_device_id}:
+ get:
+ description: Get all GPU records matching the given PCI Device ID
+ operationId: getGpuByPciDeviceId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetGpuByPciDeviceIdResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get GPU by PCI Device ID
+ tags:
+ - GpuByPci
+ post:
+ description: Create a new GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')
+ operationId: createGpuByPciDeviceId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create GPU by PCI Device ID only
+ tags:
+ - GpuByPci
+ patch:
+ description: Partially update a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown'). Only provided fields will be updated.
+ operationId: updateGpuByPciDeviceId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Partially update GPU by PCI Device ID only
+ tags:
+ - GpuByPci
+ delete:
+ description: Delete a GPU record using only PCI Device ID (pciVendorId and pciSubsystemDeviceId default to 'unknown')
+ operationId: deleteGpuByPciDeviceId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete GPU by PCI Device ID only
+ tags:
+ - GpuByPci
+ /v2/gpus/pci-device-id/{pci_device_id}/pci-vendor-id/{pci_vendor_id}:
+ get:
+ description: Get all GPUs by PCI records matching the given PCI Device ID and Vendor ID
+ operationId: getGpuByPciDeviceIdVendorId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Vendor ID
+ in: path
+ name: pci_vendor_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetGpuByPciDeviceIdVendorIdResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get GPUs by PCI Device ID and Vendor ID
+ tags:
+ - GpuByPci
+ /v2/gpus/pci-device-id/{pci_device_id}/pci-vendor-id/{pci_vendor_id}/pci-subsystem-device-id/{pci_subsystem_device_id}:
+ get:
+ description: Get a single GPU record matching the full PCI composite key
+ operationId: getGpuByPciDeviceIdVendorIdSubsystemDeviceId
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Vendor ID
+ in: path
+ name: pci_vendor_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Subsystem Device ID
+ in: path
+ name: pci_subsystem_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get GPU by PCI Device ID, Vendor ID, and Subsystem Device ID
+ tags:
+ - GpuByPci
+ post:
+ description: Create a new GPU record using the full PCI composite key
+ operationId: createGpuByPciFullKey
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Vendor ID
+ in: path
+ name: pci_vendor_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Subsystem Device ID
+ in: path
+ name: pci_subsystem_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create GPU by PCI Device ID, Vendor ID, and Subsystem Device ID
+ tags:
+ - GpuByPci
+ patch:
+ description: Partially update a GPU record matching the full PCI composite key. Only provided fields will be updated.
+ operationId: updateGpuByPciFullKey
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Vendor ID
+ in: path
+ name: pci_vendor_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Subsystem Device ID
+ in: path
+ name: pci_subsystem_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Partially update GPU by PCI Device ID, Vendor ID, and Subsystem Device ID
+ tags:
+ - GpuByPci
+ delete:
+ description: Delete a GPU record matching the full PCI composite key
+ operationId: deleteGpuByPciFullKey
+ parameters:
+ - description: PCI Device ID
+ in: path
+ name: pci_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Vendor ID
+ in: path
+ name: pci_vendor_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ - description: PCI Subsystem Device ID
+ in: path
+ name: pci_subsystem_device_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 32
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete GPU by PCI Device ID, Vendor ID, and Subsystem Device ID
+ tags:
+ - GpuByPci
+ /v2/helm-charts/{org_name}/{artifact_name}/versions:
+ get:
+ description: List chart versions in org as guest
+ operationId: listHelmChartVersionsInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List chart versions in org as guest
+ tags:
+ - Helm Charts
+ /v2/helm-charts/{org_name}/{artifact_name}/versions/{version_id}:
+ get:
+ description: Get chart version in org as guest
+ operationId: getHelmChartVersionInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get chart version in org as guest
+ tags:
+ - Helm Charts
+ /v2/helm-charts/{org_name}/{team_name}/{artifact_name}/versions:
+ get:
+ description: List chart versions in team as guest
+ operationId: listHelmChartVersionsInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List chart versions in team as guest
+ tags:
+ - Helm Charts
+ /v2/helm-charts/{org_name}/{team_name}/{artifact_name}/versions/{version_id}:
+ get:
+ description: Get chart version in team as guest
+ operationId: getHelmChartVersionInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get chart version in team as guest
+ tags:
+ - Helm Charts
+ /v2/models:
+ get:
+ description: This operation lists public models.
+ operationId: listPublicModels
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public models
+ tags:
+ - Models
+ /v2/models/{org_name}/{model_name}:
+ get:
+ description: This operation gets info of a model in the org as guest.
+ operationId: getModelInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model in org as guest
+ tags:
+ - Models
+ /v2/models/{org_name}/{model_name}/versions:
+ get:
+ description: List model versions in org as guest
+ operationId: listModelVersionsInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model versions in org as guest
+ tags:
+ - Model Version
+ /v2/models/{org_name}/{model_name}/versions/{version_id}:
+ get:
+ description: Get model version in org as guest
+ operationId: getModelVersionInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model version in org as guest
+ tags:
+ - Model Version
+ /v2/models/{org_name}/{model_name}/versions/{version_id}/files:
+ get:
+ description: List files of the model version in org as guest
+ operationId: listModeFilesInOrgAsGuest_2
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model files in org as guest
+ tags:
+ - Model Version Files
+ /v2/models/{org_name}/{team_name}/{model_name}:
+ get:
+ description: This operation gets info of a model in the org/team as guest.
+ operationId: getModelInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model in team as guest
+ tags:
+ - Models
+ /v2/models/{org_name}/{team_name}/{model_name}/versions:
+ get:
+ description: List model versions in team as guest
+ operationId: listModelVersionsInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model versions in team as guest
+ tags:
+ - Model Version
+ /v2/models/{org_name}/{team_name}/{model_name}/versions/{version_id}:
+ get:
+ description: Get model version in team as guest
+ operationId: getModelVersionInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model version in team as guest
+ tags:
+ - Model Version
+ /v2/models/{org_name}/{team_name}/{model_name}/versions/{version_id}/files:
+ get:
+ description: List files of the model version in team as guest
+ operationId: listModeFilesInTeamAsGuest_2
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model files in team as guest
+ tags:
+ - Model Version Files
+ /v2/nim/{team}/{nim_name}/{tag}/metadata:
+ post:
+ description: |
+ Registers NIM profile metadata for the given team, NIM name, and tag. This is a placeholder that validates the supplied profiles and echoes the provided fields back to the caller.
+ SSA: requires the following scope `createNimMetadata`
+ operationId: createNimMetadata
+ parameters:
+ - description: Team name
+ in: path
+ name: team
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ pattern: ^[a-zA-Z0-9._-]+$
+ type: string
+ - description: NIM name
+ in: path
+ name: nim_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ pattern: ^[a-zA-Z0-9._-]+$
+ type: string
+ - description: NIM tag
+ in: path
+ name: tag
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ pattern: ^[a-zA-Z0-9._-]+$
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NimManifestMetadataRequest'
+ required: true
+ responses:
+ '201':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/NimManifestMetadataResponse'
+ description: Created
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create NIM metadata
+ tags:
+ - NIM Metadata
+ /v2/recipes:
+ get:
+ description: List public recipes
+ operationId: listPublicRecipes
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public recipes
+ tags:
+ - Resources
+ /v2/recipes/{org_name}/{recipe_name}:
+ get:
+ description: Get recipe details in org as guest
+ operationId: getRecipeInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in org as guest
+ tags:
+ - Resources
+ /v2/recipes/{org_name}/{recipe_name}/versions:
+ get:
+ description: List recipe versions in org as guest
+ operationId: listRecipeVersionsInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in org as guest
+ tags:
+ - Resource Versions
+ /v2/recipes/{org_name}/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in org as guest
+ operationId: getRecipeVersionInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in org as guest
+ tags:
+ - Resource Versions
+ /v2/recipes/{org_name}/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List files of the recipe version in org as guest
+ operationId: listModeFilesInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in org as guest
+ tags:
+ - Resource Version Files endpoints
+ /v2/recipes/{org_name}/{team_name}/{recipe_name}:
+ get:
+ description: Get recipe details in team as guest
+ operationId: getRecipeInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in team as guest
+ tags:
+ - Resources
+ /v2/recipes/{org_name}/{team_name}/{recipe_name}/versions:
+ get:
+ description: List recipe versions in team as guest
+ operationId: listRecipeVersionsInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in team as guest
+ tags:
+ - Resource Versions
+ /v2/recipes/{org_name}/{team_name}/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in team as guest
+ operationId: getRecipeVersionInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in team as guest
+ tags:
+ - Resource Versions
+ /v2/recipes/{org_name}/{team_name}/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List files of the recipe version in team as guest
+ operationId: listModeFilesInTeamAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in team as guest
+ tags:
+ - Resource Version Files endpoints
+ /v2/resources:
+ get:
+ description: List public recipes
+ operationId: listPublicRecipes_1
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public recipes
+ tags:
+ - Resources
+ /v2/resources/{org_name}/{recipe_name}:
+ get:
+ description: Get recipe details in org as guest
+ operationId: getRecipeInOrgAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in org as guest
+ tags:
+ - Resources
+ /v2/resources/{org_name}/{recipe_name}/versions:
+ get:
+ description: List recipe versions in org as guest
+ operationId: listRecipeVersionsInOrgAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in org as guest
+ tags:
+ - Resource Versions
+ /v2/resources/{org_name}/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in org as guest
+ operationId: getRecipeVersionInOrgAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in org as guest
+ tags:
+ - Resource Versions
+ /v2/resources/{org_name}/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List files of the recipe version in org as guest
+ operationId: listModeFilesInOrgAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in org as guest
+ tags:
+ - Resource Version Files endpoints
+ /v2/resources/{org_name}/{team_name}/{recipe_name}:
+ get:
+ description: Get recipe details in team as guest
+ operationId: getRecipeInTeamAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in team as guest
+ tags:
+ - Resources
+ /v2/resources/{org_name}/{team_name}/{recipe_name}/versions:
+ get:
+ description: List recipe versions in team as guest
+ operationId: listRecipeVersionsInTeamAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in team as guest
+ tags:
+ - Resource Versions
+ /v2/resources/{org_name}/{team_name}/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in team as guest
+ operationId: getRecipeVersionInTeamAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in team as guest
+ tags:
+ - Resource Versions
+ /v2/resources/{org_name}/{team_name}/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List files of the recipe version in team as guest
+ operationId: listModeFilesInTeamAsGuest_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in team as guest
+ tags:
+ - Resource Version Files endpoints
+ /v2/{artifact_type}:
+ get:
+ description: List public artifacts
+ operationId: listPublicArtifacts
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List public artifacts
+ tags:
+ - Artifacts
+ /v2/{artifact_type}/{org_name}/{artifact_name}:
+ get:
+ description: Get artifact details in org as guest
+ operationId: getArtifactInOrgAsGuest
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact in org as guest
+ tags:
+ - Artifacts
+ /v2/{artifact_type}/{org_name}/{artifact_name}/versions/{version_id}/files:
+ get:
+ description: List files of the artifact version in org as guest
+ operationId: listArtifactFilesInOrgAsGuest
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact files in org as guest
+ tags:
+ - Artifact Version Files
+ /v2/{artifact_type}/{org_name}/{team_name}/{artifact_name}:
+ get:
+ description: Get artifact details in team as guest
+ operationId: getChartInTeamAsGuest
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact in team as guest
+ tags:
+ - Artifacts
+ /v2/{artifact_type}/{org_name}/{team_name}/{artifact_name}/versions/{version_id}/files:
+ get:
+ description: List files of the artifact version in team as guest
+ operationId: listArtifactFilesInTeamAsGuest
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact files in team as guest
+ tags:
+ - Artifact Version Files
+ /v2/{artifact_type}/{org_name}/{artifact_name}/spec:
+ get:
+ description: Get AI Playground for public artifactType
+ operationId: getPublicModelArtifactsSpec
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get AI Playground for public artifactType
+ tags:
+ - AIPlayground
+ /v2/{artifact_type}/{org_name}/{team_name}/{artifact_name}/spec:
+ get:
+ description: Get AI Playground for public artifactType
+ operationId: getPublicModelArtifactsSpec_1
+ parameters:
+ - description: Organization name
+ in: path
+ name: org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get AI Playground for public artifactType
+ tags:
+ - AIPlayground
+components:
+ schemas:
+ CollectionListResponse:
+ description: Response to list collections request
+ properties:
+ collections:
+ items:
+ $ref: '#/components/schemas/Collection'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ Response:
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CollectionResponse:
+ description: Response to create collection request
+ properties:
+ collection:
+ $ref: '#/components/schemas/Collection'
+ description: Collection object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactListResponse:
+ description: Response to list artifacts request
+ properties:
+ artifacts:
+ items:
+ $ref: '#/components/schemas/Artifact'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CloudServiceProviderListResponse:
+ description: Response to list Cloud Service Providers request
+ properties:
+ cloudServiceProviders:
+ items:
+ $ref: '#/components/schemas/CloudServiceProvider'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CloudServiceProviderCreateRequest:
+ description: Request to create a new Cloud Service Provider
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ description:
+ description: Description of the Cloud Service Provider
+ type: string
+ displayName:
+ description: Display name of the Cloud Service Provider
+ type: string
+ isEnabled:
+ description: Determines if this Cloud Service Provider is enabled
+ type: boolean
+ labels:
+ items:
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the Cloud Service Provider
+ type: string
+ required:
+ - name
+ type: object
+ CloudServiceProvider:
+ description: Cloud Service Provider object
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the Cloud Service Provider
+ type: string
+ displayName:
+ description: Display name of the Cloud Service Provider
+ type: string
+ isDeployable:
+ description: Determines if this Cloud Service Provider can be used to deploy artifacts
+ type: boolean
+ isEnabled:
+ description: Determines if this Cloud Service Provider is enabled
+ type: boolean
+ labels:
+ items:
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the Cloud Service Provider
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ required:
+ - name
+ type: object
+ DeploymentParametersListResponse:
+ description: Response to list deployment parameters request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ deploymentParameters:
+ items:
+ $ref: '#/components/schemas/DeploymentParameters'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ DeploymentParameters:
+ description: Deployment Artifact Parameters object
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ CloudServiceProviderUpdateRequest:
+ description: Request to update existing Cloud Service Provider
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ description:
+ description: Description of the Cloud Service Provider
+ type: string
+ displayName:
+ description: Display name of the Cloud Service Provider
+ type: string
+ isEnabled:
+ description: Determines if this Cloud Service Provider is enabled
+ type: boolean
+ labels:
+ items:
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ type: object
+ DeploymentParametersUpdateRequest:
+ description: Request to update existing deployment parameters
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ DeploymentParametersCreateRequest:
+ description: Request to create a new deployment parameters
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ DeploymentParametersMeta:
+ description: Cloud Service Provider Deployment Parameters object
+ properties:
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParametersMeta'
+ description: Cloud Service Provider Deployment CPU Parameters object
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParametersMeta'
+ description: Cloud Service Provider Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParametersMeta'
+ description: Cloud Service Provider Deployment Memory Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParametersMeta'
+ description: Cloud Service Provider Deployment Storage Parameters object
+ type: object
+ DeploymentParametersMetaUpdateRequest:
+ description: Properties for the cloud service provider deployment parameters meta to create
+ properties:
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParametersMeta'
+ description: Cloud Service Provider Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParametersMeta'
+ description: Cloud Service Provider Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParametersMeta'
+ description: Cloud Service Provider Deployment Memory Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParametersMeta'
+ description: Cloud Service Provider Deployment Storage Parameters object
+ type: object
+ DeploymentParametersMetaCreateRequest:
+ description: Properties for the cloud service provider deployment parameters meta to create
+ properties:
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParametersMeta'
+ description: Cloud Service Provider Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParametersMeta'
+ description: Cloud Service Provider Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParametersMeta'
+ description: Cloud Service Provider Deployment Memory Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParametersMeta'
+ description: Cloud Service Provider Deployment Storage Parameters object
+ required:
+ - gpu
+ - storage
+ type: object
+ GpuByPciResponse:
+ description: Response for GPU by PCI ID lookup
+ properties:
+ createdAt:
+ description: Creation timestamp
+ format: date-time
+ type: string
+ cudaMajorVersion:
+ description: CUDA major version
+ type: string
+ cudaMinorVersion:
+ description: CUDA minor version
+ type: string
+ displayName:
+ description: Display name for the GPU
+ type: string
+ formFactor:
+ description: GPU form factor
+ type: string
+ gpuCounts:
+ items:
+ format: int32
+ maximum: 255
+ minimum: 0
+ type: integer
+ type: array
+ uniqueItems: true
+ labelName:
+ description: Label name for the GPU
+ type: string
+ memorySizeGb:
+ description: Memory size in GB (smallint range)
+ format: int32
+ maximum: 32767
+ minimum: 0
+ type: integer
+ pciDeviceId:
+ description: PCI Device ID
+ type: string
+ pciSubsystemDeviceId:
+ description: PCI Subsystem Device ID
+ type: string
+ pciVendorId:
+ description: PCI Vendor ID
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ updatedAt:
+ description: Last update timestamp
+ format: date-time
+ type: string
+ required:
+ - displayName
+ - pciDeviceId
+ type: object
+ GpuByPciUpdateRequest:
+ description: GPU by PCI update properties
+ properties:
+ cudaMajorVersion:
+ description: CUDA major version
+ type: string
+ cudaMinorVersion:
+ description: CUDA minor version
+ type: string
+ displayName:
+ description: Display name for the GPU
+ type: string
+ formFactor:
+ description: GPU form factor
+ type: string
+ gpuCounts:
+ items:
+ format: int32
+ maximum: 255
+ minimum: 0
+ type: integer
+ type: array
+ uniqueItems: true
+ labelName:
+ description: Label name for the GPU
+ type: string
+ memorySizeGb:
+ description: Memory size in GB (smallint range)
+ format: int32
+ maximum: 32767
+ minimum: 0
+ type: integer
+ type: object
+ GpuByPciCreateRequest:
+ description: GPU by PCI properties
+ properties:
+ cudaMajorVersion:
+ description: CUDA major version
+ type: string
+ cudaMinorVersion:
+ description: CUDA minor version
+ type: string
+ displayName:
+ description: Display name for the GPU
+ type: string
+ formFactor:
+ description: GPU form factor
+ type: string
+ gpuCounts:
+ items:
+ format: int32
+ maximum: 255
+ minimum: 0
+ type: integer
+ type: array
+ uniqueItems: true
+ labelName:
+ description: Label name for the GPU
+ type: string
+ memorySizeGb:
+ description: Memory size in GB (smallint range)
+ format: int32
+ maximum: 32767
+ minimum: 0
+ type: integer
+ pciDeviceId:
+ description: PCI Device ID
+ type: string
+ pciSubsystemDeviceId:
+ description: PCI Subsystem Device ID
+ type: string
+ pciVendorId:
+ description: PCI Vendor ID
+ type: string
+ required:
+ - displayName
+ - pciDeviceId
+ type: object
+ ArtifactVersionListResponse:
+ description: Response to list artifact versions request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactVersions:
+ items:
+ $ref: '#/components/schemas/ArtifactVersion'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactVersionResponse:
+ description: Response to artifact version request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactVersion:
+ $ref: '#/components/schemas/ArtifactVersion'
+ description: Artifact version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelListResponse:
+ description: Response to list models request
+ properties:
+ models:
+ items:
+ $ref: '#/components/schemas/Model'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelResponse:
+ description: Response to create model request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelVersionListResponse:
+ description: Response to list model versions request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelVersions:
+ items:
+ $ref: '#/components/schemas/ModelVersion'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelVersionResponse:
+ description: Response to create a model version request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelVersion:
+ $ref: '#/components/schemas/ModelVersion'
+ description: Model version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelVersionFileListResponse:
+ description: Response to list files for model version request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelFiles:
+ items:
+ $ref: '#/components/schemas/ModelFile'
+ type: array
+ modelVersion:
+ $ref: '#/components/schemas/ModelVersion'
+ description: Model version object
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ NimManifestMetadataRequest:
+ description: NIM profile metadata
+ properties:
+ profiles:
+ items:
+ $ref: '#/components/schemas/NimProfile'
+ type: array
+ type: object
+ NimManifestMetadataResponse:
+ properties:
+ profiles:
+ items:
+ $ref: '#/components/schemas/NimProfile'
+ type: array
+ type: object
+ RecipeListResponse:
+ description: Response to list recipes request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipes:
+ items:
+ $ref: '#/components/schemas/Recipe'
+ type: array
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeResponse:
+ description: Response to recipe request
+ properties:
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeVersionListResponse:
+ description: Response to list recipe versions request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeVersions:
+ items:
+ $ref: '#/components/schemas/RecipeVersion'
+ type: array
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeVersionResponse:
+ description: Response to recipe version request
+ properties:
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeVersion:
+ $ref: '#/components/schemas/RecipeVersion'
+ description: Recipe version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeVersionFileListResponse:
+ description: Response to list files for recipe version request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeFiles:
+ items:
+ $ref: '#/components/schemas/RecipeFile'
+ type: array
+ recipeVersion:
+ $ref: '#/components/schemas/RecipeVersion'
+ description: Recipe version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactResponse:
+ description: Response to artifact request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactVersionFileListResponse:
+ description: Response to list files for artifact version request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactFiles:
+ items:
+ $ref: '#/components/schemas/File'
+ type: array
+ artifactVersion:
+ $ref: '#/components/schemas/ArtifactVersion'
+ description: Artifact version object
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ AIPlaygroundResponse:
+ description: Request to fetch an AI Playground config
+ properties:
+ artifactName:
+ description: Unique name of the model
+ type: string
+ artifactType:
+ description: ArtifactTypeEnum of the artifact
+ type: string
+ attributes:
+ description: Metadata json string
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ namespace:
+ description: org/team of the model
+ type: string
+ nvcfFunctionId:
+ description: NVCF function id for the model playground
+ type: string
+ nvcfInferencePath:
+ description: NVCF inference path (invocation route) for the model playground
+ type: string
+ openAPISpec:
+ description: OpenAPI specification for this model
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ Collection:
+ description: Collection object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ builtBy:
+ description: Organization that built the collection
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ category:
+ enum:
+ - HEALTHCARE
+ - SMART_CITIES
+ - RETAIL
+ - MANUFACTURING
+ - SUPERCOMPUTING
+ - ROBOTICS
+ - AUTOMOTIVE
+ - TELECOMMUNICATIONS
+ - FINANCE
+ - OIL_AND_GAS
+ - NATURAL_LANGUAGE_PROCESSING
+ - AUTOMATIC_SPEECH_RECOGNITION
+ - INTELLIGENT_VIDEO_ANALYTICS
+ - OBJECT_DETECTION
+ - IMAGE_CLASSIFICATION
+ - ANNOTATION
+ - IMAGE_SYNTHESIS
+ - MACHINE_LEARNING
+ - DEEP_LEARNING
+ - INFRASTRUCTURE
+ - HIGH_PERFORMANCE_COMPUTING
+ - WINDOWS_RTX_ACCELERATED_MODELS
+ - BEGINNER
+ - ADVANCED
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the collection
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ isPublic:
+ description: Determines if this collection is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the collection
+ type: string
+ orgName:
+ description: Name of the org that the collection belongs to
+ type: string
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publisher:
+ description: Organization that published this collection
+ type: string
+ shortDescription:
+ description: Short description of the collection
+ type: string
+ size:
+ description: Total count of collection items
+ format: int64
+ type: integer
+ teamName:
+ description: Name of the team that the collection belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ required:
+ - category
+ type: object
+ PaginationInfo:
+ description: Pagination Information
+ properties:
+ index:
+ description: Page index of results
+ format: int32
+ type: integer
+ nextPage:
+ description: Serialized pointer to the next results page. Should be used for fetching next page. Can be empty
+ type: string
+ size:
+ description: Number of results in page
+ format: int32
+ type: integer
+ totalPages:
+ description: Total number of pages available
+ format: int64
+ type: integer
+ totalResults:
+ description: Total number of results available
+ format: int64
+ type: integer
+ type: object
+ RequestStatus:
+ description: Request status information
+ properties:
+ requestId:
+ description: Request ID
+ type: string
+ serverId:
+ description: Server ID
+ type: string
+ statusCode:
+ description: Describes response status reported by the server.
+ enum:
+ - UNKNOWN
+ - SUCCESS
+ - UNAUTHORIZED
+ - PAYMENT_REQUIRED
+ - FORBIDDEN
+ - TIMEOUT
+ - EXISTS
+ - NOT_FOUND
+ - INTERNAL_ERROR
+ - INVALID_REQUEST
+ - INVALID_REQUEST_VERSION
+ - INVALID_REQUEST_DATA
+ - METHOD_NOT_ALLOWED
+ - CONFLICT
+ - UNPROCESSABLE_ENTITY
+ - TOO_MANY_REQUESTS
+ - INSUFFICIENT_STORAGE
+ - SERVICE_UNAVAILABLE
+ type: string
+ statusDescription:
+ description: Status description
+ type: string
+ type: object
+ Artifact:
+ description: Artifact object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ artifactType:
+ description: Artifact type
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ type: string
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ bias:
+ description: Text describing bias in the artifact
+ type: string
+ builtBy:
+ description: Organization that built the helm chart
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the helm chart
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ encryptionKeyId:
+ description: ID of the customer managed encryption key associated with this artifact
+ type: string
+ explainability:
+ description: Text describing the explainability for this artifact
+ type: string
+ hasSignedVersion:
+ description: Indicates if the artifact has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if helm chart is user's favorite
+ type: boolean
+ isPublic:
+ description: Determines if this helm chart is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionId:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the helm chart
+ type: string
+ orgName:
+ description: Name of the org that the helm chart belongs to
+ type: string
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ privacy:
+ description: Text describing the privacy for this artifact
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publisher:
+ description: Organization that published this helm chart
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the artifact
+ type: string
+ shortDescription:
+ description: Short description of the helm chart
+ type: string
+ teamName:
+ description: Name of the team that the helm chart belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ ArtifactAttribute:
+ description: Attribute on the artifact
+ properties:
+ key:
+ maxLength: 255
+ pattern: '[a-zA-Z0-9]+'
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ DeploymentArtifactParameters:
+ description: Deployment Artifact Parameters object
+ properties:
+ artifactType:
+ description: Artifact type
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ type: string
+ displayName:
+ description: Display name of the artifact
+ type: string
+ filePath:
+ description: Path to a file in an artifact version
+ type: string
+ name:
+ description: Unique name of the artifact
+ type: string
+ orgName:
+ description: Name of the org that the artifact belongs to
+ type: string
+ teamName:
+ description: Name of the team that the artifact belongs to
+ type: string
+ versionId:
+ description: ID of the version or tag
+ type: string
+ required:
+ - name
+ - orgName
+ type: object
+ DeploymentCpuParameters:
+ description: Deployment CPU Parameters object
+ properties:
+ count:
+ description: Total count of CPUs
+ format: int64
+ type: integer
+ type: object
+ DeploymentGpuParameters:
+ description: Deployment GPU Parameters object
+ properties:
+ count:
+ description: Total count of GPUs
+ format: int64
+ type: integer
+ type:
+ description: GPU Type
+ type: string
+ type: object
+ DeploymentMemoryParameters:
+ description: Deployment Memory Parameters object
+ properties:
+ capacityInGB:
+ description: Capacity in GB
+ format: int64
+ type: integer
+ type: object
+ DeploymentStorageParameters:
+ description: Deployment Storage Parameters object
+ properties:
+ capacityInGB:
+ description: Capacity in GB
+ format: int64
+ type: integer
+ type: object
+ DeploymentCpuParametersMeta:
+ description: Cloud Service Provider Deployment CPU Parameters object
+ properties:
+ count:
+ $ref: '#/components/schemas/CountableResource'
+ description: Countable Resource object
+ required:
+ - count
+ type: object
+ DeploymentGpuParametersMeta:
+ description: Cloud Service Provider Deployment GPU Parameters object
+ properties:
+ count:
+ $ref: '#/components/schemas/CountableResource'
+ description: Countable Resource object
+ type:
+ $ref: '#/components/schemas/EnumerableResource'
+ description: Enumerable Resource object
+ required:
+ - type
+ type: object
+ DeploymentMemoryParametersMeta:
+ description: Cloud Service Provider Deployment Memory Parameters object
+ properties:
+ capacityInGB:
+ $ref: '#/components/schemas/CountableResource'
+ description: Countable Resource object
+ required:
+ - capacityInGB
+ type: object
+ DeploymentStorageParametersMeta:
+ description: Cloud Service Provider Deployment Storage Parameters object
+ properties:
+ capacityInGB:
+ $ref: '#/components/schemas/CountableResource'
+ description: Countable Resource object
+ required:
+ - capacityInGB
+ type: object
+ ArtifactVersion:
+ description: Artifact version object
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ createdByUser:
+ description: Id of the user who created this version
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the version
+ type: string
+ id:
+ description: Unique ID of the version
+ type: string
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the version in bytes
+ format: int64
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ Model:
+ description: Model object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ application:
+ description: Application of the model
+ type: string
+ bias:
+ description: Text describing bias in the model
+ type: string
+ builtBy:
+ description: organization that built the repository
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the model
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ encryptionKeyId:
+ description: ID of the customer managed encryption key associated with this artifact
+ type: string
+ explainability:
+ description: Text describing explainability for this model
+ type: string
+ framework:
+ description: Framework used to train this model
+ type: string
+ hasPlayground:
+ description: indicate if the Model has AI Playground configured
+ type: boolean
+ hasSignedVersion:
+ description: Indicates if the model has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if model is user's favorite
+ type: boolean
+ isPlaygroundEnabled:
+ description: indicate if AI Playground is enabled in the catalog
+ type: boolean
+ isPublic:
+ description: Determines if model is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionGpuModel:
+ description: GPU model and memory used for the latest version
+ type: string
+ latestVersionId:
+ description: 'Deprecated: Please use latestVersionIdStr instead. ID of the latest version'
+ format: int64
+ type: integer
+ latestVersionIdStr:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ modelFormat:
+ description: Format of the model
+ type: string
+ name:
+ description: Unique name of the model
+ type: string
+ orgName:
+ description: Name of the org that the model belongs to
+ type: string
+ ownerName:
+ description: Name of model's owner
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ precision:
+ description: Precision this model was trained with
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the repository
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ type: string
+ shortDescription:
+ description: Short description of the model
+ type: string
+ teamName:
+ description: Name of the team that the model belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ versions:
+ items:
+ type: string
+ type: array
+ type: object
+ ModelVersion:
+ description: Model version object
+ properties:
+ accuracyReached:
+ description: Accuracy this model reached
+ format: float
+ type: number
+ batchSize:
+ description: Batch size this model was trained with
+ format: int64
+ type: integer
+ createdByUser:
+ description: Id of the user who created this model
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the model version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ type: string
+ id:
+ description: 'Deprecated: Please use versionId instead. Unique ID of the version'
+ format: int64
+ type: integer
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ memoryFootprint:
+ description: Model size/memory footprint for inference
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this model trained
+ format: int64
+ type: integer
+ nvcfContainerConfiguration:
+ $ref: '#/components/schemas/NvcfContainerConfiguration'
+ description: NVCF container configuration parameters
+ nvcfDeploymentSpecification:
+ $ref: '#/components/schemas/NvcfDeploymentSpecification'
+ description: NVCF deployment specification
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the model in bytes
+ format: int64
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ type: string
+ type: object
+ ModelFile:
+ description: Model file object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the model
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sha256_base64:
+ description: Base64 encoded sha256 hash of the artifact file
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ type: object
+ NimProfile:
+ properties:
+ buildable_profile:
+ type: boolean
+ checksum:
+ type: string
+ feat_lora:
+ type: boolean
+ form_factor:
+ type: string
+ gpu:
+ type: string
+ gpu_device:
+ type: string
+ inference_backend:
+ type: string
+ latency:
+ additionalProperties: {}
+ type: object
+ min_vram_per_device_gb:
+ format: double
+ type: number
+ pipeline_parallel_size:
+ format: int32
+ type: integer
+ precision:
+ type: string
+ profile_id:
+ type: string
+ tensor_parallel_size:
+ format: int32
+ type: integer
+ workspace_hash:
+ type: string
+ type: object
+ Recipe:
+ description: Recipe object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ advanced:
+ description: Text for describing advanced information
+ type: string
+ application:
+ enum:
+ - CLASSIFICATION
+ - OBJECT_DETECTION
+ - SEGMENTATION
+ - TRANSLATION
+ - TEXT_TO_SPEECH
+ - RECOMMENDER
+ - SENTIMENT
+ - NLP
+ - KUBEFLOW_PIPELINE
+ - OTHER
+ - SPEAKER_VERIFICATION
+ - PUNCTUATION_AND_CAPITALIZATION
+ - DIALOG_STATE_TRACKING
+ - SPEAKER_DIARIZATION
+ - SPEAKER_RECOGNITION
+ - SPEECH_SYNTHESIS
+ - VOICE_ACTIVITY_DETECTION
+ - SPEECH_RECOGNITION
+ - LANGUAGE_MODELING
+ - NAMED_ENTITY_RECOGNITION
+ - TEXT_CLASSIFICATION
+ - TEXT_PROCESSING
+ - QUESTION_ANSWERING
+ - CONTENT_GENERATION
+ type: string
+ builtBy:
+ description: Organization that built the recipe
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the recipe
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ hasSignedVersion:
+ description: Indicates if the recipe has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if recipe is user's favorite
+ type: boolean
+ isPublic:
+ description: Determines if this recipe is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionId:
+ description: 'Deprecated: Please use latestVersionIdStr instead. ID of the latest version'
+ format: int64
+ type: integer
+ latestVersionIdStr:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ modelFormat:
+ description: Format of the model this recipe produces
+ type: string
+ name:
+ description: Unique name of the recipe
+ type: string
+ orgName:
+ description: Name of the org that the recipe belongs to
+ type: string
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ precision:
+ enum:
+ - FP16
+ - FP32
+ - INT8
+ - FPBOTH
+ - OTHER
+ - ALL
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: Organization that published this recipe
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ relatedModels:
+ items:
+ $ref: '#/components/schemas/Model'
+ type: array
+ setup:
+ description: Text describing recipe setup
+ type: string
+ shortDescription:
+ description: Short description of the recipe
+ type: string
+ teamName:
+ description: Name of the team that the recipe belongs to
+ type: string
+ trainingFramework:
+ enum:
+ - TensorFlow
+ - Caffe2
+ - CNTK
+ - Torch
+ - PyTorch
+ - MXNet
+ - Keras
+ - Other
+ - TransferLearningToolkit
+ - TensorFlow2
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ RecipeVersion:
+ description: Recipe version object
+ properties:
+ accuracyReached:
+ description: Accuracy this recipe reached
+ format: float
+ type: number
+ batchSize:
+ description: Batch size this recipe was trained with
+ format: int64
+ type: integer
+ createdByUser:
+ description: Id of the user who created this recipe
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the recipe version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ type: string
+ id:
+ description: 'Deprecated: Please use versionId instead. Unique ID of the version'
+ format: int64
+ type: integer
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ memoryFootprint:
+ description: recipe size/memory footprint for inference
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this recipe trained
+ format: int64
+ type: integer
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ releaseNotes:
+ description: Text describing this release
+ type: string
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ setup:
+ description: Text describing recipe setup
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the recipe in bytes
+ format: int64
+ type: integer
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ type: string
+ type: object
+ RecipeFile:
+ description: Recipe file object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the recipe
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sha256_base64:
+ description: Base64 encoded sha256 hash of the artifact file
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ type: object
+ File:
+ description: File object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the object
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ LicenseMetadata:
+ description: License information for the artifact
+ properties:
+ configuredLicenseTerms:
+ $ref: '#/components/schemas/ConfiguredLicenseTerms'
+ description: License information for the artifact
+ governingTerms:
+ description: Comprehensive terms and links related to the license
+ example: GOVERNING HOSTING TERMS: Use of the model is governed by the NVIDIA Open Model Agreement.
+ maxLength: 1000
+ pattern: ^[\s\S]*$
+ type: string
+ licenseId:
+ description: License ID
+ example: NVIDIA proprietary
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ licenseVersion:
+ description: License version ID
+ example: v1.0
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ needsAcceptance:
+ description: Indicator if user needs to accept this license
+ type: boolean
+ required:
+ - governingTerms
+ - licenseId
+ - licenseVersion
+ type: object
+ CountableResource:
+ description: Countable Resource object
+ properties:
+ defaultValue:
+ description: 'Deprecated: Default value. Please use actual CloudServiceProvider values instead'
+ format: int64
+ type: integer
+ maxValue:
+ description: Maximum value
+ format: int64
+ type: integer
+ minValue:
+ description: Minimum value
+ format: int64
+ type: integer
+ type: object
+ EnumerableResource:
+ description: Enumerable Resource object
+ properties:
+ defaultItemName:
+ description: 'Deprecated: Default item name. Please use actual CloudServiceProvider values instead'
+ type: string
+ items:
+ items:
+ $ref: '#/components/schemas/EnumerableResourceItem'
+ type: array
+ type: object
+ CustomMetricGroup:
+ description: Defines the group of custom metrics.
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/CustomMetric'
+ type: array
+ name:
+ maxLength: 255
+ type: string
+ type: object
+ Dataset:
+ properties:
+ license:
+ description: License of the dataset
+ maxLength: 255
+ type: string
+ link:
+ description: Link to the dataset
+ maxLength: 255
+ type: string
+ name:
+ description: Name of the dataset
+ maxLength: 255
+ type: string
+ type: object
+ NvcfContainerConfiguration:
+ description: NVCF container configuration parameters
+ properties:
+ apiBodyFormat:
+ description: API body format
+ type: string
+ containerArgs:
+ description: Container arguments
+ type: string
+ containerEnvironment:
+ items:
+ $ref: '#/components/schemas/MetaData'
+ type: array
+ containerImage:
+ description: Container Image
+ type: string
+ healthUri:
+ description: Health URI
+ type: string
+ inferencePort:
+ description: Inference port
+ type: string
+ inferenceUrl:
+ description: Inference url
+ type: string
+ models:
+ items:
+ $ref: '#/components/schemas/NvcfContainerModel'
+ type: array
+ type: object
+ NvcfDeploymentSpecification:
+ description: NVCF deployment specification
+ properties:
+ gpuCount:
+ description: GPU count
+ format: int32
+ type: integer
+ gpuType:
+ description: GPU type
+ type: string
+ instanceType:
+ description: Instance type
+ type: string
+ maxConcurrency:
+ description: Maximum concurrency
+ format: int32
+ type: integer
+ type: object
+ ConfiguredLicenseTerms:
+ description: License information for the artifact
+ properties:
+ download:
+ $ref: '#/components/schemas/ConfiguredLicenseTerm'
+ description: License information for the artifact
+ hosting:
+ $ref: '#/components/schemas/ConfiguredLicenseTerm'
+ description: License information for the artifact
+ type: object
+ EnumerableResourceItem:
+ description: Enumerable Resource Item object
+ properties:
+ displayName:
+ description: Display name
+ type: string
+ logo:
+ description: Logo URL
+ type: string
+ name:
+ description: Name
+ type: string
+ type: object
+ CustomMetric:
+ description: Custom metrics
+ properties:
+ key:
+ maxLength: 255
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ MetaData:
+ properties:
+ key:
+ maxLength: 255
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ NvcfContainerModel:
+ description: Models version object metadata
+ properties:
+ name:
+ description: Model name
+ type: string
+ uri:
+ description: Model URI
+ type: string
+ version:
+ description: Model version
+ type: string
+ type: object
+ ConfiguredLicenseTerm:
+ description: License information for the artifact
+ properties:
+ artifactType:
+ description: Artifact type
+ example: model
+ maxLength: 15
+ pattern: ^[\s\S]*$
+ type: string
+ generatedHtml:
+ description: Generated html
+ example: GOVERNING HOSTING TERMS: ...
+ maxLength: 9999
+ pattern: ^[\s\S]*$
+ type: string
+ tags:
+ items:
+ $ref: '#/components/schemas/LicenseTag'
+ type: array
+ type: object
+ LicenseTag:
+ description: License tag information for individual term
+ properties:
+ category:
+ description: Category of the tag
+ example: terms
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ key:
+ description: Key identifier for the tag
+ example: nv-open-model
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ label:
+ description: License Label
+ example: NVIDIA Open Model Agreement
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ tag:
+ description: License tag name
+ example: Model Agreement
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ url:
+ description: Link to the hosted license
+ example: https://www.nvidia.com/.../nvidia-open-model-agreement/
+ maxLength: 1000
+ pattern: ^[\s\S]*$
+ type: string
+ type: object
+ GetGpusResponse:
+ type: object
+ properties:
+ gpus:
+ type: array
+ items:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ GetGpuByPciDeviceIdResponse:
+ type: object
+ properties:
+ gpu_by_pci_device_id:
+ type: array
+ items:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ GetGpuByPciDeviceIdVendorIdResponse:
+ type: object
+ properties:
+ gpu_by_pci_device_id_vendor_id:
+ type: array
+ items:
+ $ref: '#/components/schemas/GpuByPciResponse'
+ x-stackQL-resources:
+ collections:
+ id: nvidia.catalog.collections
+ name: collections
+ title: Collections
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1collections/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collections
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1collections~1{org_name}~1{collection_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collection
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1collections~1{org_name}~1{team_name}~1{collection_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collection
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/collections/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/get'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ collection_artifacts:
+ id: nvidia.catalog.collection_artifacts
+ name: collection_artifacts
+ title: Collection Artifacts
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1collections~1{org_name}~1{collection_name}~1artifacts~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1collections~1{org_name}~1{team_name}~1{collection_name}~1artifacts~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ csps:
+ id: nvidia.catalog.csps
+ name: csps
+ title: Csps
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1csps/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.cloudServiceProviders
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/csps/methods/get'
+ - $ref: '#/components/x-stackQL-resources/csps/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/csps/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/csps/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/csps/methods/delete'
+ replace: []
+ artifact_deployment_params:
+ id: nvidia.catalog.artifact_deployment_params
+ name: artifact_deployment_params
+ title: Artifact Deployment Params
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{artifact_type}~1{org_name}~1{artifact_name}~1deployments~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.deploymentParameters
+ request:
+ nativeCasing: kebab
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{artifact_type}~1{org_name}~1{artifact_name}~1deployments~1{csp_name}~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{artifact_type}~1{org_name}~1{team_name}~1{artifact_name}~1deployments~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.deploymentParameters
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{artifact_type}~1{org_name}~1{team_name}~1{artifact_name}~1deployments~1{csp_name}~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/get'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ csp_deployment_params:
+ id: nvidia.catalog.csp_deployment_params
+ name: csp_deployment_params
+ title: Csp Deployment Params
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params/methods/get'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params/methods/delete'
+ replace: []
+ csp_deployment_params_meta:
+ id: nvidia.catalog.csp_deployment_params_meta
+ name: csp_deployment_params_meta
+ title: Csp Deployment Params Meta
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params~1meta/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params~1meta/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params~1meta/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1csps~1{csp_name}~1deployments~1params~1meta/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params_meta/methods/get'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params_meta/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params_meta/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/csp_deployment_params_meta/methods/delete'
+ replace: []
+ gpus:
+ id: nvidia.catalog.gpus
+ name: gpus
+ title: Gpus
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1gpus/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.gpus
+ overrideMediaType: application/json
+ schema_override:
+ $ref: '#/components/schemas/GetGpusResponse'
+ transform:
+ body: |-
+ {{- $wrapped := printf "{\"gpus\":%s}" . -}}
+ {{- $wrapped -}}
+ type: golang_template_text_v0.3.0
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.gpu_by_pci_device_id
+ overrideMediaType: application/json
+ schema_override:
+ $ref: '#/components/schemas/GetGpuByPciDeviceIdResponse'
+ transform:
+ body: |-
+ {{- $wrapped := printf "{\"gpu_by_pci_device_id\":%s}" . -}}
+ {{- $wrapped -}}
+ type: golang_template_text_v0.3.0
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_vendor:
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}~1pci-vendor-id~1{pci_vendor_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.gpu_by_pci_device_id_vendor_id
+ overrideMediaType: application/json
+ schema_override:
+ $ref: '#/components/schemas/GetGpuByPciDeviceIdVendorIdResponse'
+ transform:
+ body: |-
+ {{- $wrapped := printf "{\"gpu_by_pci_device_id_vendor_id\":%s}" . -}}
+ {{- $wrapped -}}
+ type: golang_template_text_v0.3.0
+ request:
+ nativeCasing: camel
+ get_by_vendor_subsystem:
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}~1pci-vendor-id~1{pci_vendor_id}~1pci-subsystem-device-id~1{pci_subsystem_device_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_by_vendor_subsystem:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}~1pci-vendor-id~1{pci_vendor_id}~1pci-subsystem-device-id~1{pci_subsystem_device_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update_by_vendor_subsystem:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}~1pci-vendor-id~1{pci_vendor_id}~1pci-subsystem-device-id~1{pci_subsystem_device_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_vendor_subsystem:
+ operation:
+ $ref: '#/paths/~1v2~1gpus~1pci-device-id~1{pci_device_id}~1pci-vendor-id~1{pci_vendor_id}~1pci-subsystem-device-id~1{pci_subsystem_device_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/get_by_vendor_subsystem'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/get_by_vendor'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/get'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/create_by_vendor_subsystem'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/update_by_vendor_subsystem'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/delete_by_vendor_subsystem'
+ - $ref: '#/components/x-stackQL-resources/gpus/methods/delete'
+ replace: []
+ helm_chart_versions:
+ id: nvidia.catalog.helm_chart_versions
+ name: helm_chart_versions
+ title: Helm Chart Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1helm-charts~1{org_name}~1{artifact_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1helm-charts~1{org_name}~1{artifact_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersion
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1helm-charts~1{org_name}~1{team_name}~1{artifact_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1helm-charts~1{org_name}~1{team_name}~1{artifact_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersion
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ models:
+ id: nvidia.catalog.models
+ name: models
+ title: Models
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.models
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{model_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.model
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{team_name}~1{model_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.model
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/models/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/get'
+ - $ref: '#/components/x-stackQL-resources/models/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ model_versions:
+ id: nvidia.catalog.model_versions
+ name: model_versions
+ title: Model Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{model_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{model_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersion
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{team_name}~1{model_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{team_name}~1{model_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersion
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ model_files:
+ id: nvidia.catalog.model_files
+ name: model_files
+ title: Model Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{model_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1models~1{org_name}~1{team_name}~1{model_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/model_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ nim_metadata:
+ id: nvidia.catalog.nim_metadata
+ name: nim_metadata
+ title: Nim Metadata
+ methods:
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nim~1{team}~1{nim_name}~1{tag}~1metadata/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '201'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/nim_metadata/methods/create'
+ update: []
+ delete: []
+ replace: []
+ recipes:
+ id: nvidia.catalog.recipes
+ name: recipes
+ title: Recipes
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1recipes/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{team_name}~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/get'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ recipe_versions:
+ id: nvidia.catalog.recipe_versions
+ name: recipe_versions
+ title: Recipe Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{team_name}~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{team_name}~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ recipe_files:
+ id: nvidia.catalog.recipe_files
+ name: recipe_files
+ title: Recipe Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1recipes~1{org_name}~1{team_name}~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipe_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ resources:
+ id: nvidia.catalog.resources
+ name: resources
+ title: Resources
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1resources/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{team_name}~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resources/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/get'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ resource_versions:
+ id: nvidia.catalog.resource_versions
+ name: resource_versions
+ title: Resource Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{team_name}~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{team_name}~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ resource_files:
+ id: nvidia.catalog.resource_files
+ name: resource_files
+ title: Resource Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1resources~1{org_name}~1{team_name}~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resource_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifacts:
+ id: nvidia.catalog.artifacts
+ name: artifacts
+ title: Artifacts
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{artifact_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifact
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{team_name}~1{artifact_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifact
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/get'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_files:
+ id: nvidia.catalog.artifact_files
+ name: artifact_files
+ title: Artifact Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{artifact_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{team_name}~1{artifact_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_specs:
+ id: nvidia.catalog.artifact_specs
+ name: artifact_specs
+ title: Artifact Specs
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{artifact_name}~1spec/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1v2~1{artifact_type}~1{org_name}~1{team_name}~1{artifact_name}~1spec/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/get'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+servers:
+ - url: https://api.ngc.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/nvcf_deployments.yaml b/providers/src/nvidia/v00.00.00000/services/nvcf_deployments.yaml
new file mode 100644
index 00000000..d35baeac
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/nvcf_deployments.yaml
@@ -0,0 +1,2364 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA Cloud Functions - Deployments
+ description: 'NVCF deployments and GPU specifications, cluster groups and GPU inventory, registry credentials and telemetry endpoints (source: the published NVCF OpenAPI specification; served from api.ngc.nvidia.com).'
+ version: 2.261.2
+paths:
+ /v2/nvcf/clusterGroups:
+ get:
+ deprecated: true
+ description: 'Lists Cluster Groups for the current account. The response includes cluster groups defined specifically in the current account and publicly available cluster groups such as GFN, OCI, etc. Requires a bearer token with ''list_cluster_groups'' scope in HTTP Authorization header. '
+ operationId: getClusterGroups
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClusterGroupsResponse'
+ description: OK
+ summary: List Cluster Groups
+ tags:
+ - Cluster Groups and GPUs
+ parameters: []
+ /v2/nvcf/deployments/functions/{function_id}/versions/{function_version_id}:
+ get:
+ description: 'Allows Account Admins to retrieve the deployment details of the specified function version. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: getFunctionDeployment
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentResponse'
+ description: OK
+ summary: Get Function Deployment Details
+ tags:
+ - Function Deployment
+ post:
+ description: 'Initiates deployment for the specified function version. Upon invocation of this endpoint, the function''s status transitions to ''DEPLOYING''. If the specified function version is public, then Account Admin cannot perform this operation. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: createFunctionDeployment
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FunctionDeploymentRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentResponse'
+ description: OK
+ summary: Deploy Function
+ tags:
+ - Function Deployment
+ put:
+ deprecated: true
+ description: ' Deprecated and will be removed soon. Use a single GPU specification update method instead. Updates the deployment specs of the specified function version. It''s important to note that GPU type and backend configurations cannot be modified through this endpoint. If the specified function is public, then Account Admin cannot perform this operation. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: updateFunctionDeployment
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateFunctionDeploymentRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentResponse'
+ description: OK
+ summary: Update Function Deployment
+ tags:
+ - Function Deployment
+ delete:
+ description: 'Deletes the deployment associated with the specified function. Upon deletion, any active instances will be terminated, and the function''s status will transition to ''INACTIVE''. To undeploy a function version gracefully, specify ''graceful=true'' query parameter, allowing current tasks to complete before terminating the instances. If the specified function version is public, then Account Admin cannot perform this operation. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: deleteFunctionDeployment
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Query param to deactivate function for graceful shutdown
+ in: query
+ name: graceful
+ required: false
+ schema:
+ default: false
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FunctionResponse'
+ description: OK
+ summary: Delete Function Deployment
+ tags:
+ - Function Deployment
+ /v2/nvcf/deployments/{deployment_id}:
+ get:
+ description: 'Allows Account Admins to retrieve the deployment details of the specified deployment id. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: getFunctionDeployment_1
+ parameters:
+ - description: Deployment id
+ in: path
+ name: deployment_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentResponse'
+ description: OK
+ summary: Get Function Deployment Details
+ tags:
+ - Function Deployment
+ /v2/nvcf/deployments/{deployment_id}/gpu-specifications/{gpu_spec_id}:
+ patch:
+ description: ' Updates the GPU specification of the specified function version''s deployment. It''s important to note that GPU type and backend configurations cannot be modified through this endpoint. If the specified function is public, then Account Admin cannot perform this operation. Access to this endpoint mandates a bearer token with ''deploy_function'' scope in the HTTP Authorization header. '
+ operationId: updateGpuSpecification
+ parameters:
+ - description: Deployment id
+ in: path
+ name: deployment_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: GPU Specification id
+ in: path
+ name: gpu_spec_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateGpuSpecificationRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateGpuSpecificationResponse'
+ description: OK
+ summary: Update the specified GPU specification under the specified deployment
+ tags:
+ - Function Deployment
+ /v2/nvcf/recognized-registries:
+ get:
+ description: 'Lists all the registries that are recognized by NVCF. Only when a registry is recognized by NVCF that the users can add its credential to their account and then use it to create functions. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: getRecognizedRegistries
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecognizedRegistriesResponse'
+ description: OK
+ summary: List Recognized Registries
+ tags:
+ - Registry Credential Management
+ parameters: []
+ /v2/nvcf/registry-credentials:
+ get:
+ description: 'Lists all the registry credentials associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: listRegistryCredentialDetails
+ parameters:
+ - description: |
+ Filters registry credentials using the specified 'artifactType' query param.
+ in: query
+ name: artifactType
+ required: false
+ schema:
+ default:
+ - CONTAINER
+ - HELM
+ - MODEL
+ - RESOURCE
+ items:
+ enum:
+ - CONTAINER
+ - HELM
+ - MODEL
+ - RESOURCE
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ - description: |
+ Filters registry credentials using the specified 'provisionedBy' query param.
+ in: query
+ name: provisionedBy
+ required: false
+ schema:
+ default:
+ - SYSTEM
+ - USER
+ items:
+ enum:
+ - SYSTEM
+ - USER
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListRegistryCredentialDetailsResponse'
+ description: OK
+ summary: List Registry Credentials
+ tags:
+ - Registry Credential Management
+ post:
+ description: 'Adds a new registry credential to the account. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: addRegistryCredential
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AddRegistryCredentialRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RegistryCredentialDetailsResponse'
+ description: OK
+ summary: Add new registry credential to the account
+ tags:
+ - Registry Credential Management
+ parameters: []
+ /v2/nvcf/registry-credentials/{registry_credential_id}:
+ get:
+ description: 'Retrieves detailed information of the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: getRegistryCredentialDetails
+ parameters:
+ - description: Registry Credential id
+ in: path
+ name: registry_credential_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RegistryCredentialDetailsResponse'
+ description: OK
+ summary: Get Registry Credential Details
+ tags:
+ - Registry Credential Management
+ patch:
+ description: 'Updates the secret and/or the artifact types associated with the specified registry credential. Artifact types specified in the request body are added to the set of artifact types that already exist for the specified registry credential. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: updateRegistryCredential
+ parameters:
+ - description: Registry Credential id
+ in: path
+ name: registry_credential_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateRegistryCredentialRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RegistryCredentialDetailsResponse'
+ description: OK
+ summary: Update registry credential
+ tags:
+ - Registry Credential Management
+ delete:
+ description: 'Deletes the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with ''manage_registries'' scope. '
+ operationId: deleteRegistryCredential
+ parameters:
+ - description: Registry Credential id
+ in: path
+ name: registry_credential_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '204':
+ description: No Content
+ summary: Delete Registry Credential
+ tags:
+ - Registry Credential Management
+ /v2/nvcf/secrets/telemetries/{telemetry_id}:
+ put:
+ description: 'Updates secret for the specific telemetry Id within NVIDIA Cloud Account. This endpoint requires a bearer token with ''update_secrets'' scope in the HTTP Authorization header. '
+ operationId: updateTelemetrySecret
+ parameters:
+ - description: NVIDIA Cloud Account Id
+ in: path
+ name: telemetry_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateTelemetrySecretRequest'
+ required: true
+ responses:
+ '204':
+ description: No Content
+ summary: Update secret for a specific Telemetry Id
+ tags:
+ - User Secret Management
+ /v2/nvcf/telemetries:
+ get:
+ description: 'Retrieves telemetry configurations for a specific NVIDIA Cloud Account. requires a bearer token with ''manage_telemetries'' scope in the HTTP Authorization header. '
+ operationId: getTelemetriesByAccount
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListTelemetryResponse'
+ description: OK
+ summary: List Telemetries
+ tags:
+ - Telemetry Management
+ parameters: []
+ post:
+ description: 'Creates telemetry endpoints for NVIDIA Cloud Accounts. requires a bearer token with ''manage_telemetries'' scope in the HTTP Authorization header. '
+ operationId: createTelemetry
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TelemetryRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TelemetryResponse'
+ description: OK
+ summary: Create Telemetry
+ tags:
+ - Telemetry Management
+ parameters: []
+ /v2/nvcf/telemetries/{telemetry_id}:
+ get:
+ description: 'Retrieves the details of a specific telemetry configuration by its ID. requires a bearer token with ''manage_telemetries'' scope in the HTTP Authorization header. '
+ operationId: getTelemetry
+ parameters:
+ - in: path
+ name: telemetry_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TelemetryResponse'
+ description: OK
+ summary: Get Telemetry Details
+ tags:
+ - Telemetry Management
+ delete:
+ description: 'Deletes a specific telemetry configuration for a NVIDIA Cloud Account. requires a bearer token with ''manage_telemetries'' scope in the HTTP Authorization header. If there any functions that are dependent on the Telemetry that is being deleted, then response with 400 status code will be returned. '
+ operationId: deleteTelemetry
+ parameters:
+ - in: path
+ name: telemetry_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '204':
+ description: No Content
+ '400':
+ description: Cannot be deleted till Functions depend on it
+ summary: Delete Telemetry
+ tags:
+ - Telemetry Management
+components:
+ schemas:
+ ClusterGroupsResponse:
+ properties:
+ clusterGroups:
+ items:
+ $ref: '#/components/schemas/ClusterGroup'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ type: object
+ FunctionResponse:
+ description: Response body with function details
+ properties:
+ function:
+ $ref: '#/components/schemas/FunctionDto'
+ description: Function details
+ required:
+ - function
+ type: object
+ DeploymentResponse:
+ description: Function Deployment Response
+ properties:
+ deployment:
+ $ref: '#/components/schemas/FunctionDeploymentDto'
+ description: Deployment details
+ required:
+ - deployment
+ type: object
+ FunctionDeploymentRequest:
+ description: Request to deploy a function
+ properties:
+ deploymentSpecifications:
+ description: GPU specs with GPU, instance-type, clusters etc. details
+ items:
+ $ref: '#/components/schemas/GpuSpecificationDto'
+ maxItems: 2147483647
+ minItems: 1
+ type: array
+ required:
+ - deploymentSpecifications
+ type: object
+ UpdateFunctionDeploymentRequest:
+ description: Request to update function deployment spec
+ properties:
+ deploymentSpecifications:
+ description: Deployment specs with GPU, instance-type, etc. details for update request
+ items:
+ $ref: '#/components/schemas/UpdateGpuSpecificationDto'
+ maxItems: 2147483647
+ minItems: 1
+ type: array
+ required:
+ - deploymentSpecifications
+ type: object
+ UpdateGpuSpecificationRequest:
+ description: Request to update single function deployment GPU Specification
+ properties:
+ autoscalingConfiguration:
+ $ref: '#/components/schemas/AutoscalingConfigurationDto'
+ description: Customizable Autoscaling configuration
+ autoscalingConfigurationPolicy:
+ description: 'Autoscaling configuration policy. CUSTOM_CONFIGURATION (default): use the provided autoscalingConfig. PLATFORM_CONFIGURATION: remove custom config and use platform defaults.'
+ enum:
+ - CUSTOM_CONFIGURATION
+ - PLATFORM_CONFIGURATION
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ maxInstances:
+ description: Maximum number of instances for the deployment
+ format: int32
+ maximum: 2147483647
+ minimum: 0
+ type: integer
+ nullable: true
+ minInstances:
+ description: Minimum number of instances for the deployment
+ format: int32
+ maximum: 2147483647
+ minimum: 0
+ type: integer
+ nullable: true
+ type: object
+ UpdateGpuSpecificationResponse:
+ description: Update GPU Specification Response
+ properties:
+ gpuSpecification:
+ $ref: '#/components/schemas/GpuSpecificationDto'
+ description: GPU Specification details
+ required:
+ - gpuSpecification
+ type: object
+ RecognizedRegistriesResponse:
+ description: Response body for recognized registries endpoint
+ properties:
+ recognizedRegistries:
+ additionalProperties:
+ items:
+ additionalProperties:
+ type: string
+ type: object
+ type: array
+ description: Recognized registries
+ type: object
+ type: object
+ ListRegistryCredentialDetailsResponse:
+ description: Response body containing list of registry credentials
+ properties:
+ registryCredentials:
+ description: List of registry credentials
+ items:
+ $ref: '#/components/schemas/RegistryCredentialDetailsDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - registryCredentials
+ type: object
+ AddRegistryCredentialRequest:
+ description: Request body to add a registry credential to an account
+ properties:
+ artifactTypes:
+ description: Artifact types that can be retrieved using this credential
+ items:
+ enum:
+ - CONTAINER
+ - HELM
+ - MODEL
+ - RESOURCE
+ type: string
+ maxItems: 2147483647
+ minItems: 1
+ type: array
+ uniqueItems: true
+ description:
+ description: Optional registry credential description
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ registryHostname:
+ description: Registry hostname
+ format: UTF-8
+ maxLength: 255
+ minLength: 1
+ pattern: (?=^.{4,253}$)(^((?!-)[a-zA-Z0-9-]{1,63}(?>'name' AS gpu,
+ it.value->>'name' AS instance_type,
+ it.value->>'description' AS instance_description,
+ (it.value->>'default')::boolean AS is_default,
+ cg.clusters::jsonb->0->>'name' AS cluster,
+ cg.nca_id
+ FROM nvidia.nvcf_deployments.cluster_groups cg,
+ jsonb_array_elements(cg.gpus::jsonb) AS g(value),
+ jsonb_array_elements(g.value->'instanceTypes') AS it(value)
+servers:
+ - url: https://api.ngc.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/nvcf_functions.yaml b/providers/src/nvidia/v00.00.00000/services/nvcf_functions.yaml
new file mode 100644
index 00000000..9674fc13
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/nvcf_functions.yaml
@@ -0,0 +1,1995 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA Cloud Functions - Functions
+ description: 'NVCF functions and versions, function metadata, authorizations (function sharing grants), secrets and rate limits (source: the published NVCF OpenAPI specification; management operations served from api.ngc.nvidia.com).'
+ version: 2.261.2
+paths:
+ /v2/nvcf/authorizations/functions:
+ get:
+ description: 'Lists all the function versions in an account that have been shared/authorized with/to other accounts. Response includes the nca-ids of the authorized accounts. If a function version is not shared/authorized, then it is not included in the response. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: getAuthorizedPartiesForAllFunctions
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListAuthorizedPartiesResponse'
+ description: OK
+ summary: List Functions Authorized/Shared With Other Accounts
+ tags:
+ - Function Sharing
+ parameters: []
+ /v2/nvcf/authorizations/functions/{function_id}:
+ get:
+ description: 'Lists function versions of the specified function and their corresponding authorized accounts allowed to invoke the function version. Individual versions of a function can have their own authorized accounts. So, each object in the array can have different authorized accounts listed. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: getAuthorizedPartiesForAllVersions
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListAuthorizedPartiesResponse'
+ description: OK
+ summary: List Function Versions with Authorized Accounts For Specified Function
+ tags:
+ - Function Sharing
+ post:
+ description: 'Authorizes additional NVIDIA Cloud Accounts to invoke any version of the specified function. By default, a function belongs to the NVIDIA Cloud Account that created it, and the credentials used for function invocation must reference the same NVIDIA Cloud Account. Upon invocation of this endpoint, any existing authorized accounts will be overwritten by the newly specified authorized accounts. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: createAuthorizedPartiesForAllVersions
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Authorize Accounts To Invoke Function
+ tags:
+ - Function Sharing
+ delete:
+ description: 'Deletes authorizations at the function level. This impacts all versions of the function. If a function versions has its own set of authorizations, those are not deleted. If the specified function is public, then Account Admin cannot perform this operation. Note that the response does not include any authz accounts at version level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: deleteAuthorizedPartiesForAllVersions
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Delete All Authorizations At Function Level
+ tags:
+ - Function Sharing
+ /v2/nvcf/authorizations/functions/{function_id}/add:
+ patch:
+ description: 'Adds the specified NVIDIA Cloud Account to the set of authorized accounts that are can invoke all the versions of the specified function. If the specified function does not have any existing inheritable authorized accounts, it results in a response with status 404. If the specified account is already in the set of existing inheritable authorized accounts, it results in a response with status code 409. If a function is public, then Account Admin cannot perform this operation. Note that response only includes authz accounts at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: addAuthorizedPartyForAllVersions
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchAuthorizedPartyRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Authorize Another Account To Invoke, List, and Check Queue Details of Function
+ tags:
+ - Function Sharing
+ /v2/nvcf/authorizations/functions/{function_id}/remove:
+ patch:
+ description: 'Removes the specified NVIDIA Cloud Account from the set of authorized accounts that can invoke all the versions of the specified function. If the specified function does not have any existing inheritable authorized parties, it results in a response with status 404. Also, if the specified account is not in the existing set of inheritable authorized accounts, it results in a response with status 404. If the specified function is public, then Account Admin cannot perform this operation. Note that response only includes the remaining authorized accounts at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: removeAuthorizedPartyForAllVersions
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchAuthorizedPartyRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Unauthorize Account From Invoking, Listing, and Checking Queue Details of Function
+ tags:
+ - Function Sharing
+ /v2/nvcf/authorizations/functions/{function_id}/versions/{function_version_id}:
+ get:
+ description: 'Gets NVIDIA Cloud Account IDs that are authorized to invoke specified function version. Response includes authorized accounts that were added specifically at the version level and the authorized accounts that were inherited from function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: getAuthorizedPartiesForSpecificVersion
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Get Account Authorizations For Function Version
+ tags:
+ - Function Sharing
+ post:
+ description: 'Authorizes additional NVIDIA Cloud Accounts to invoke a specific function version. By default, a function belongs to the NVIDIA Cloud Account that created it, and the credentials used for function invocation must reference the same NVIDIA Cloud Account. Upon invocation of this endpoint, any existing authorized accounts will be overwritten by the newly specified authorized accounts. Note that the response does NOT include inherited authorized accounts that were added at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: createAuthorizedPartiesForSpecificVersion
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Authorize Accounts To Invoke/List Function Version
+ tags:
+ - Function Sharing
+ delete:
+ description: 'Deletes all the authorized accounts that are directly associated with the specified function version. Authorized parties that are inherited by the function version are not deleted. If the specified function version is public, then Account Admin cannot perform this operation. Note that the response does not include inherited authorized accounts that were added at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: deleteAuthorizedPartiesForSpecificVersion
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Delete All Authorizations At Version Level
+ tags:
+ - Function Sharing
+ /v2/nvcf/authorizations/functions/{function_id}/versions/{function_version_id}/add:
+ patch:
+ description: 'Adds the specified NVIDIA Cloud Account to the set of authorized accounts that can invoke the specified function version. If the specified function version does not have any existing inheritable authorized accounts, it results in a response with status 404. If the specified account is already in the set of existing authorized accounts that are directly associated with the function version, it results in a response wit status code 409. If a function is public, then Account Admin cannot perform this operation. Note that the response does not include inherited authorized accounts that were added at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: addAuthorizedPartyForSpecificVersion
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchAuthorizedPartyRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Authorize Another Account To Invoke, List, and Check Queue Details of Function Version
+ tags:
+ - Function Sharing
+ /v2/nvcf/authorizations/functions/{function_id}/versions/{function_version_id}/remove:
+ patch:
+ description: 'Removes the specified NVIDIA Cloud Account from the set of authorized accounts that are directly associated with specified function version. If the specified function version does not have any of its own(not inherited) authorized accounts, it results in a response with status 404. Also, if the specified authorized account is not in the set of existing authorized parties that are directly associated with the specified function version, it results in a response with status code 404. If the specified function version is public, then Account Admin cannot perform this operation. Note that the response does not include inherited authorized accounts that were added at the function level. Access to this functionality mandates the inclusion of a bearer token with the ''authorize_clients'' scope in the HTTP Authorization header '
+ operationId: removeAuthorizedPartyForSpecificVersion
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PatchAuthorizedPartyRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizedPartiesResponse'
+ description: OK
+ summary: Unauthorize Account From Invoking, Listing, and Checking Queue Details of Function Version
+ tags:
+ - Function Sharing
+ /v2/nvcf/functions:
+ get:
+ description: Lists all the functions associated with the authenticated NVIDIA Cloud Account. Requires a bearer token with 'list_functions' or 'list_functions_details' scope in the HTTP Authorization header.
+ operationId: getFunctions
+ parameters:
+ - description: |
+ Query param 'visibility' indicates the kind of functions to be included
+ in the response.
+ in: query
+ name: visibility
+ required: false
+ schema:
+ default:
+ - authorized
+ - private
+ - public
+ items:
+ enum:
+ - authorized
+ - private
+ - public
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListFunctionsResponse'
+ description: OK
+ summary: List Functions
+ tags:
+ - Function Management
+ post:
+ description: 'Creates a new function within the authenticated NVIDIA Cloud Account. Requires a bearer token with ''register_function'' scope in the HTTP Authorization header. '
+ operationId: createFunction
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateFunctionRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateFunctionResponse'
+ description: OK
+ summary: Create Function
+ tags:
+ - Function Management
+ parameters: []
+ /v2/nvcf/functions/ids:
+ get:
+ description: 'Lists ids of all the functions in the authenticated NVIDIA Cloud Account. Requires a bearer token with ''list_functions'' or ''list_functions_details'' scopes in the HTTP Authorization header. '
+ operationId: getFunctionIds
+ parameters:
+ - description: |
+ Query param 'visibility' indicates the kind of functions to be included
+ in the response.
+ in: query
+ name: visibility
+ required: false
+ schema:
+ default:
+ - authorized
+ - private
+ - public
+ items:
+ enum:
+ - authorized
+ - private
+ - public
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListFunctionIdsResponse'
+ description: OK
+ summary: List Function Ids
+ tags:
+ - Function Management
+ /v2/nvcf/functions/{function_id}/versions:
+ get:
+ description: 'Lists details of all the versions of the specified function in the authenticated NVIDIA Cloud Account. Requires a bearer token with ''list_functions'' or ''list_functions_details'' scopes in the HTTP Authorization header. '
+ operationId: getFunctions_1
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListFunctionsResponse'
+ description: OK
+ summary: List Function Versions
+ tags:
+ - Function Management
+ post:
+ description: 'Creates a version of the specified function within the authenticated NVIDIA Cloud Account. If the function is public, then Account Admin cannot create a version. Requires a bearer token with ''register_function'' scope in the HTTP Authorization header. '
+ operationId: createFunction_1
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateFunctionRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateFunctionResponse'
+ description: OK
+ summary: Create Function Version
+ tags:
+ - Function Management
+ /v2/nvcf/functions/{function_id}/versions/{function_version_id}:
+ get:
+ description: 'Retrieves detailed information of the specified function version in the authenticated NVIDIA Cloud Account. Requires a bearer token with ''list_functions'' or ''list_functions_details'' scopes in the HTTP Authorization header. '
+ operationId: getFunction
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: 'Version id '
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: |
+ Query param 'includeSecrets' indicates whether to include secret names
+ for the function in the response.
+ in: query
+ name: includeSecrets
+ required: false
+ schema:
+ default: true
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FunctionResponse'
+ description: OK
+ summary: Get Function Version Details
+ tags:
+ - Function Management
+ put:
+ description: 'Updates mutable fields of the specified function version within the authenticated NVIDIA Cloud Account. The current request payload supports tags updates, rate limit updates, and model-specific LLM config updates. Requires a bearer token with ''update_function'' scope in the HTTP Authorization header. '
+ operationId: updateFunction
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateFunctionRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FunctionResponse'
+ description: OK
+ summary: Updates mutable fields of the specified function version.
+ tags:
+ - Function Management
+ delete:
+ description: 'Deletes the specified function version in the authenticated NVIDIA Cloud Account. Requires a bearer token with ''delete_function'' scope in the HTTP Authorization header. If the function version is public, then Account Admin cannot delete the function. '
+ operationId: deleteFunction
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '204':
+ description: No Content
+ summary: Delete Function
+ tags:
+ - Function Management
+ /v2/nvcf/metadata/functions/{function_id}/versions/{function_version_id}:
+ put:
+ deprecated: true
+ description: 'Deprecated: use PUT /v2/nvcf/functions/{functionId}/versions/{functionVersionId} to update tags, rate limit, model-specific LLM config, and other mutable function fields. This legacy endpoint updates the same mutable function version fields for the authenticated NVIDIA Cloud Account and requires a bearer token with ''update_function'' scope in the HTTP Authorization header. '
+ operationId: updateFunctionMetadata
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateFunctionRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FunctionResponse'
+ description: OK
+ summary: Update Function Metadata
+ tags:
+ - Function Management
+ /v2/nvcf/ratelimit/functions/{function_id}/versions/{version_id}:
+ put:
+ deprecated: true
+ description: 'Deprecated: use PUT /v2/nvcf/functions/{functionId}/versions/{versionId} to update ratelimit and other mutable function fields. This legacy endpoint only updates ratelimit for the specified function version and requires a bearer token with ''update_function'' scope in the HTTP Authorization header. '
+ operationId: updateRateLimit
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateFunctionRequest'
+ required: true
+ responses:
+ '204':
+ description: No Content
+ summary: Update user ratelimit for a function version
+ tags:
+ - User Ratelimit Management
+ delete:
+ description: 'Delete ratelimit for the specified function version. This endpoint requires a bearer token with ''update_function'' scope in the HTTP Authorization header. '
+ operationId: deleteRateLimit
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '204':
+ description: No Content
+ summary: Delete user ratelimit for a function version
+ tags:
+ - User Ratelimit Management
+ /v2/nvcf/secrets/functions/{function_id}/versions/{version_id}:
+ put:
+ description: 'Updates secrets for the specified function version. This endpoint requires a bearer token with ''update_secrets'' scope in the HTTP Authorization header. '
+ operationId: updateFunctionSecrets
+ parameters:
+ - description: Function Id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function Version Id
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateFunctionSecretsRequest'
+ required: true
+ responses:
+ '204':
+ description: No Content
+ summary: Update user secrets for a function version
+ tags:
+ - User Secret Management
+components:
+ schemas:
+ ListAuthorizedPartiesResponse:
+ description: Parties authorized to invoke function
+ properties:
+ functions:
+ description: Functions with authorized parties and other details
+ items:
+ $ref: '#/components/schemas/AuthorizedPartiesByFunctionDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - functions
+ type: object
+ AuthorizedPartiesResponse:
+ description: Parties authorized to invoke function
+ properties:
+ function:
+ $ref: '#/components/schemas/AuthorizedPartiesByFunctionDto'
+ description: Function with authorized parties and other details
+ required:
+ - function
+ type: object
+ AuthorizedPartiesRequest:
+ description: Request to associated authorized parties for a specific version or allversions of a function
+ properties:
+ authorizedParties:
+ description: Parties authorized to invoke function
+ items:
+ $ref: '#/components/schemas/AuthorizedPartyDto'
+ maxItems: 2147483647
+ minItems: 1
+ type: array
+ required:
+ - authorizedParties
+ type: object
+ PatchAuthorizedPartyRequest:
+ description: |
+ Request payload to associate/disassociate authorized party with function
+ properties:
+ authorizedParty:
+ $ref: '#/components/schemas/AuthorizedPartyDto'
+ description: Authorized party
+ required:
+ - authorizedParty
+ type: object
+ ListFunctionsResponse:
+ description: Response body containing list of functions
+ properties:
+ functions:
+ description: List of functions
+ items:
+ $ref: '#/components/schemas/FunctionDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - functions
+ type: object
+ CreateFunctionRequest:
+ description: Request payload to create function.
+ properties:
+ apiBodyFormat:
+ description: Invocation request body format
+ enum:
+ - PREDICT_V2
+ - CUSTOM
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ containerArgs:
+ description: Args to be passed when launching the container
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ containerEnvironment:
+ description: Environment settings for launching the container
+ items:
+ $ref: '#/components/schemas/ContainerEnvironmentEntryDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ containerImage:
+ description: Optional custom container image
+ format: uri
+ type: string
+ nullable: true
+ description:
+ description: Optional function/version description
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ functionType:
+ description: Optional function type, used to indicate a STREAMING function. Defaults to DEFAULT.
+ enum:
+ - DEFAULT
+ - STREAMING
+ - LLM
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ health:
+ $ref: '#/components/schemas/HealthDto'
+ description: Function health
+ healthUri:
+ deprecated: true
+ description: Health endpoint for the container or the helmChart
+ format: uri
+ type: string
+ nullable: true
+ helmChart:
+ description: Optional Helm Chart
+ format: uri
+ type: string
+ nullable: true
+ helmChartServiceName:
+ description: |
+ Helm Chart Service Name is required when helmChart property is specified
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ inferencePort:
+ description: |
+ Optional port number where the inference listener is running. Defaults to 8000
+ for Triton.
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ nullable: true
+ inferenceUrl:
+ description: Entrypoint for invoking the container to process a request
+ format: uri
+ type: string
+ llmInvocationConfig:
+ $ref: '#/components/schemas/LlmInvocationConfigDto'
+ description: Optional function-level LLM invocation configuration. Only valid for LLM-type functions.
+ models:
+ description: Optional list of models
+ items:
+ $ref: '#/components/schemas/FunctionModelDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ name:
+ description: Function name must start with lowercase/uppercase/digit and can only contain lowercase, uppercase, digit, hyphen, and underscore characters
+ format: UTF-8
+ maxLength: 128
+ minLength: 1
+ pattern: ^[a-z0-9A-Z][a-z0-9A-Z\-_]*$
+ type: string
+ rateLimit:
+ $ref: '#/components/schemas/RateLimitDto'
+ description: Optional rate limit config
+ resources:
+ description: Optional set of resources
+ items:
+ $ref: '#/components/schemas/ArtifactDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ secrets:
+ description: Optional secrets
+ items:
+ $ref: '#/components/schemas/SecretDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ tags:
+ description: Optional set of tags - could be empty. Provided by user
+ items:
+ pattern: '[a-zA-Z0-9\-_:=]+'
+ type: string
+ maxItems: 64
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ telemetries:
+ $ref: '#/components/schemas/TelemetriesDto'
+ description: Optional telemetry configuration for logs, metrics, and traces.
+ required:
+ - inferenceUrl
+ - name
+ type: object
+ CreateFunctionResponse:
+ description: Response body for create function request.
+ properties:
+ function:
+ $ref: '#/components/schemas/FunctionDto'
+ description: Details of the newly created function
+ required:
+ - function
+ type: object
+ ListFunctionIdsResponse:
+ description: Response body containing list of function ids in an account
+ properties:
+ functionIds:
+ description: List of function ids
+ items:
+ format: uuid
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - functionIds
+ type: object
+ FunctionResponse:
+ description: Response body with function details
+ properties:
+ function:
+ $ref: '#/components/schemas/FunctionDto'
+ description: Function details
+ required:
+ - function
+ type: object
+ UpdateFunctionRequest:
+ description: Request payload to update mutable function configuration fields.
+ properties:
+ llmInvocationConfig:
+ $ref: '#/components/schemas/LlmInvocationConfigDto'
+ description: Optional function-level LLM invocation configuration. When omitted, the existing value is preserved.
+ modelUpdates:
+ description: Optional list of model-specific updates.
+ items:
+ $ref: '#/components/schemas/ModelUpdateDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ rateLimit:
+ $ref: '#/components/schemas/RateLimitDto'
+ description: Optional full replacement for the function rate limit configuration. When omitted, the existing value is preserved. Use the delete rate-limit endpoint to clear it.
+ tags:
+ description: Optional set of function tags. When omitted, the existing value is preserved.
+ items:
+ pattern: '[a-zA-Z0-9\-_:=]+'
+ type: string
+ maxItems: 64
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ type: object
+ UpdateFunctionSecretsRequest:
+ description: Request payload to update secrets
+ properties:
+ secrets:
+ description: Secrets
+ items:
+ $ref: '#/components/schemas/SecretDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ required:
+ - secrets
+ type: object
+ AuthorizedPartiesByFunctionDto:
+ description: Data Transfer Object(DTO) representing a function with authorized accounts
+ properties:
+ authorizedParties:
+ description: Authorized parties allowed to invoke the function
+ items:
+ $ref: '#/components/schemas/AuthorizedPartyDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ id:
+ description: Function id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ ncaId:
+ description: NVIDIA Cloud Account Id
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ versionId:
+ description: Function version id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ nullable: true
+ required:
+ - id
+ - ncaId
+ type: object
+ AuthorizedPartyDto:
+ description: Data Transfer Object(DTO) representing an authorized party.
+ properties:
+ clientId:
+ description: |-
+ Client Id -- 'sub' claim in the JWT. This field should not be
+ specified anymore.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ ncaId:
+ description: NVIDIA Cloud Account authorized to invoke the function
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ required:
+ - ncaId
+ type: object
+ FunctionDto:
+ description: Data Transfer Object (DTO) representing a function
+ properties:
+ activeInstances:
+ description: List of active instances for this function.
+ items:
+ $ref: '#/components/schemas/InstanceDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ apiBodyFormat:
+ description: Invocation request body format
+ enum:
+ - PREDICT_V2
+ - CUSTOM
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ containerArgs:
+ description: Args used to launch the container
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ containerEnvironment:
+ description: Environment settings used to launch the container
+ items:
+ $ref: '#/components/schemas/ContainerEnvironmentEntryDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ containerImage:
+ description: Optional custom container
+ format: uri
+ type: string
+ nullable: true
+ createdAt:
+ description: Function creation timestamp
+ format: date-time
+ maxLength: 30
+ minLength: 8
+ type: string
+ description:
+ description: Function/version description
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ functionType:
+ description: Used to indicate a STREAMING function. Defaults to DEFAULT.
+ enum:
+ - DEFAULT
+ - STREAMING
+ - LLM
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ health:
+ $ref: '#/components/schemas/HealthDto'
+ description: Function health configuration
+ healthUri:
+ deprecated: true
+ description: Health endpoint for the container or helmChart. Deprecated, use health.uri instead.
+ format: uri
+ type: string
+ helmChart:
+ description: Optional Helm Chart
+ format: uri
+ type: string
+ nullable: true
+ helmChartServiceName:
+ description: |
+ Helm Chart Service Name specified only when helmChart property is specified
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ id:
+ description: Unique function id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ inferencePort:
+ description: Optional port number where the inference listener is running - defaults to 8000 for Triton
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ nullable: true
+ inferenceUrl:
+ description: Entrypoint for invoking the container to process requests
+ format: uri
+ type: string
+ nullable: true
+ llmInvocationConfig:
+ $ref: '#/components/schemas/LlmInvocationConfigDto'
+ description: Optional function-level LLM invocation configuration.
+ models:
+ description: Optional list of models
+ items:
+ $ref: '#/components/schemas/FunctionModelDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ name:
+ description: Function name
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ ncaId:
+ description: NVIDIA Cloud Account Id
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ ownedByDifferentAccount:
+ description: |
+ Indicates whether the function is owned by another account. If the account
+ that is being used to lookup functions happens to be authorized to invoke/list
+ this function which is owned by a different account, then this field is set
+ to true and ncaId will contain the id of the account that owns the function.
+ Otherwise, this field is not set as it defaults to false.
+ type: boolean
+ nullable: true
+ rateLimit:
+ $ref: '#/components/schemas/RateLimitDto'
+ description: Optional rate limit policy
+ resources:
+ description: Optional set of resources.
+ items:
+ $ref: '#/components/schemas/ArtifactDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ secrets:
+ description: Optional secret names
+ items:
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ status:
+ description: Function status
+ enum:
+ - ACTIVE
+ - DEPLOYING
+ - ERROR
+ - INACTIVE
+ - DELETED
+ - DEGRADED
+ - DEGRADING
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ tags:
+ description: Optional set of tags. Maximum allowed number of tags per function is 64. Maximum length of each tag is 128 chars.
+ items:
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ telemetries:
+ $ref: '#/components/schemas/TelemetriesDto'
+ description: Optional telemetry configuration for the function
+ versionId:
+ description: Unique function version id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ required:
+ - createdAt
+ - functionType
+ - healthUri
+ - id
+ - name
+ - ncaId
+ - status
+ - versionId
+ type: object
+ ContainerEnvironmentEntryDto:
+ description: Data Transfer Object(DTO) representing a container environment entry
+ properties:
+ key:
+ description: Container environment key
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ value:
+ description: Container environment value
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ required:
+ - key
+ - value
+ type: object
+ HealthDto:
+ description: Data Transfer Object(DTO) representing a function's health configuration
+ properties:
+ expectedStatusCode:
+ description: Expected return status code considered as successful.
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ port:
+ description: Port number where the health listener is running
+ format: int32
+ maximum: 2147483647
+ minimum: 0
+ type: integer
+ protocol:
+ description: HTTP/gPRC protocol type for health endpoint
+ enum:
+ - HTTP
+ - gRPC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ timeout:
+ description: ISO 8601 duration string in PnDTnHnMn.nS format
+ example: PT10S
+ format: duration
+ type: string
+ uri:
+ description: Health endpoint for the container or the helmChart
+ format: uri
+ type: string
+ required:
+ - expectedStatusCode
+ - port
+ - protocol
+ - timeout
+ - uri
+ type: object
+ LlmInvocationConfigDto:
+ description: Function-level LLM invocation configuration.
+ properties:
+ priority:
+ $ref: '#/components/schemas/PriorityDto'
+ description: Function-level request priority configuration.
+ type: object
+ FunctionModelDto:
+ description: Model associated with a function, including optional LLM routing metadata
+ properties:
+ llmConfig:
+ $ref: '#/components/schemas/LlmConfigDto'
+ description: LLM-specific configuration for this model. Only relevant for LLM-type functions.
+ name:
+ description: Model name
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ uri:
+ description: Model URI. Optional for LLM-type functions.
+ format: uri
+ type: string
+ nullable: true
+ version:
+ description: Model version. Optional for LLM-type functions.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ required:
+ - name
+ type: object
+ RateLimitDto:
+ description: Data Transfer Object(DTO) representing Rate limit config
+ properties:
+ exemptedNcaIds:
+ description: NCA ID Exemptions
+ items:
+ type: string
+ maxItems: 32
+ minItems: 0
+ type: array
+ uniqueItems: true
+ nullable: true
+ perNcaIdRate:
+ additionalProperties:
+ type: string
+ description: Per NCA ID Rate
+ type: object
+ nullable: true
+ perUserRate:
+ description: Per-user rate, intended for traffic authenticated with an invocation delegation token (InvocationToken). When set, this single rate is enforced individually against every unique caller identity, in addition to the NCA-tier limit.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ pattern: ^(?!.*-([SMHD]).*-\1)[1-9]\d*-[SMHD](,\s*[1-9]\d*-[SMHD])*$
+ type: string
+ nullable: true
+ rateLimit:
+ description: Rate
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ pattern: ^(?!.*-([SMHD]).*-\1)[1-9]\d*-[SMHD](,\s*[1-9]\d*-[SMHD])*$
+ type: string
+ nullable: true
+ syncCheck:
+ description: Sync check. Defaults to false
+ type: boolean
+ nullable: true
+ type: object
+ ArtifactDto:
+ description: Data Transfer Object(DTO) representing an artifact
+ properties:
+ name:
+ description: Artifact name
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ uri:
+ description: Artifact URI
+ format: uri
+ type: string
+ version:
+ description: Artifact version
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ required:
+ - name
+ - uri
+ - version
+ type: object
+ SecretDto:
+ description: Data Transfer Object(DTO) representing secret name/value pair
+ properties:
+ name:
+ description: Secret name
+ format: UTF-8
+ maxLength: 48
+ minLength: 1
+ pattern: ^[a-z0-9A-Z][a-z0-9A-Z\_\.\-]*$
+ type: string
+ value:
+ description: Secret value must be a string or JSON object and 1 - 32768 chars long
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ required:
+ - name
+ - value
+ type: object
+ TelemetriesDto:
+ description: Telemetry configuration for logs, metrics, and traces.
+ properties:
+ logsTelemetryId:
+ description: UUID representing the logs telemetry.
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ nullable: true
+ metricsTelemetryId:
+ description: UUID representing the metrics telemetry.
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ nullable: true
+ tracesTelemetryId:
+ description: UUID representing the traces telemetry.
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ nullable: true
+ type: object
+ ModelUpdateDto:
+ description: Model-specific update request.
+ properties:
+ llmConfig:
+ $ref: '#/components/schemas/LlmConfigUpdateDto'
+ description: Optional updates to this model's LLM config fields.
+ modelName:
+ description: Name of the model to update.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ required:
+ - modelName
+ type: object
+ InstanceDto:
+ description: Data Transfer Object(DTO) representing an instance
+ properties:
+ backend:
+ description: Backend where the instance is running
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ functionId:
+ description: Function executing on the instance
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ functionVersionId:
+ description: Function version executing on the instance
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ gpu:
+ description: GPU name powering the instance
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ icmsRequestId:
+ description: ICMS request-id used to launch this instance
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ instanceCreatedAt:
+ description: Instance creation timestamp
+ format: date-time
+ maxLength: 30
+ minLength: 8
+ type: string
+ instanceId:
+ description: Unique id of the instance
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ instanceStatus:
+ description: Instance status
+ enum:
+ - ACTIVE
+ - STARTING
+ - RUNNING
+ - ERRORED
+ - PREEMPTED
+ - DELETED
+ - TERMINATED
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ instanceType:
+ description: GPU instance-type powering the instance
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ instanceUpdatedAt:
+ description: Instance's last updated timestamp
+ format: date-time
+ maxLength: 30
+ minLength: 8
+ type: string
+ location:
+ description: Location such as zone name or region where the instance is running
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ ncaId:
+ description: NVIDIA Cloud Account Id that owns the function running on the instance
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ type: object
+ PriorityDto:
+ description: Function-level request priority. Lower value is higher priority, 0 is highest.
+ properties:
+ defaultPriority:
+ description: Default priority.
+ format: int64
+ maximum: 4294967295
+ minimum: 0
+ type: integer
+ nullable: true
+ perAccountPriority:
+ additionalProperties:
+ format: int64
+ type: integer
+ description: Per-account priority overrides, keyed by account ID.
+ type: object
+ nullable: true
+ type: object
+ LlmConfigDto:
+ description: LLM-specific configuration for a model
+ properties:
+ routingMethod:
+ description: 'Routing method for this model: a request router algorithm name, optionally followed by '';name=value'' tuning parameters, for example pulsar;seed=stable-a. The API checks only the format. The request router checks the algorithm and parameters on each request.'
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ tokenRateLimit:
+ description: Token-level rate limit for this model.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ tokenizer:
+ description: Tokenizer identifier for this model.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ uris:
+ description: OpenAI-compatible URIs supported by this model (e.g. /v1/chat/completions). Required for LLM models.
+ items:
+ type: string
+ maxItems: 2147483647
+ minItems: 1
+ type: array
+ required:
+ - uris
+ type: object
+ LlmConfigUpdateDto:
+ description: Partial update payload for LLM-specific model configuration fields.
+ properties:
+ routingMethod:
+ description: Updated routing method for the model, in the same format as llmConfig.routingMethod on create. When omitted, the existing value is preserved.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ tokenRateLimit:
+ description: Updated token-level rate limit for the model. When omitted, the existing value is preserved.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ tokenizer:
+ description: Cannot be changed after creation. A request that sets it is rejected with 400.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ uris:
+ description: Cannot be changed after creation. A request that sets it is rejected with 400.
+ items:
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ type: object
+ StackqlFunctionIdsRows:
+ type: object
+ properties:
+ function_ids:
+ type: array
+ items:
+ type: object
+ properties:
+ function_id:
+ type: string
+ description: List of function ids
+ x-stackQL-resources:
+ authorizations:
+ id: nvidia.nvcf_functions.authorizations
+ name: authorizations
+ title: Authorizations
+ methods:
+ list_all:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.functions
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.functions
+ request:
+ nativeCasing: camel
+ set:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_all:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1add/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1remove/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_version:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1versions~1{function_version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.function
+ request:
+ nativeCasing: camel
+ set_version:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1versions~1{function_version_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_all_version:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1versions~1{function_version_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_version:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1versions~1{function_version_id}~1add/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_version:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1authorizations~1functions~1{function_id}~1versions~1{function_version_id}~1remove/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/list_version'
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/list'
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/list_all'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/add_version'
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/add'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/remove_version'
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/remove'
+ replace:
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/set_version'
+ - $ref: '#/components/x-stackQL-resources/authorizations/methods/set'
+ functions:
+ id: nvidia.nvcf_functions.functions
+ name: functions
+ title: Functions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.functions
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/functions/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/functions/methods/create'
+ update: []
+ delete: []
+ replace: []
+ function_ids:
+ id: nvidia.nvcf_functions.function_ids
+ name: function_ids
+ title: Function Ids
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1ids/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ overrideMediaType: application/json
+ schema_override:
+ $ref: '#/components/schemas/StackqlFunctionIdsRows'
+ objectKey: $.function_ids
+ transform:
+ type: golang_template_json_v0.3.0
+ body: '{"function_ids":[{{ range $i, $v := .functionIds }}{{ if $i }},{{ end }}{"function_id":{{ toJson $v }}}{{ end }}]}'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/function_ids/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ function_versions:
+ id: nvidia.nvcf_functions.function_versions
+ name: function_versions
+ title: Function Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1{function_id}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.functions
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1{function_id}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1{function_id}~1versions~1{function_version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.function
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1{function_id}~1versions~1{function_version_id}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1functions~1{function_id}~1versions~1{function_version_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '204'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/function_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/function_versions/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/function_versions/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/function_versions/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/function_versions/methods/delete'
+ replace: []
+ function_metadata:
+ id: nvidia.nvcf_functions.function_metadata
+ name: function_metadata
+ title: Function Metadata
+ methods:
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1metadata~1functions~1{function_id}~1versions~1{function_version_id}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/function_metadata/methods/update'
+ delete: []
+ replace: []
+ function_ratelimits:
+ id: nvidia.nvcf_functions.function_ratelimits
+ name: function_ratelimits
+ title: Function Ratelimits
+ methods:
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1ratelimit~1functions~1{function_id}~1versions~1{version_id}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '204'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1ratelimit~1functions~1{function_id}~1versions~1{version_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '204'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/function_ratelimits/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/function_ratelimits/methods/delete'
+ replace: []
+ function_secrets:
+ id: nvidia.nvcf_functions.function_secrets
+ name: function_secrets
+ title: Function Secrets
+ methods:
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1secrets~1functions~1{function_id}~1versions~1{version_id}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '204'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/function_secrets/methods/update'
+ delete: []
+ replace: []
+servers:
+ - url: https://api.ngc.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/nvcf_invocation.yaml b/providers/src/nvidia/v00.00.00000/services/nvcf_invocation.yaml
new file mode 100644
index 00000000..f5c50fe9
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/nvcf_invocation.yaml
@@ -0,0 +1,1264 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA Cloud Functions - Invocation
+ description: NVCF HTTP-polling invocation (pexec and status), assets and invocation assertion tokens (served from api.nvcf.nvidia.com).
+ version: 2.261.2
+paths:
+ /v2/nvcf/assets:
+ get:
+ deprecated: true
+ description: 'List assets owned by the current NVIDIA Cloud Account. Requires a bearer token with ''invoke_function'' scope in the HTTP Authorization header. '
+ operationId: getAssets
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ListAssetsResponse'
+ description: OK
+ summary: List Assets
+ tags:
+ - Asset Management
+ parameters: []
+ post:
+ deprecated: true
+ description: 'Creates a unique id representing an asset and a pre-signed URL to upload the asset artifact to AWS S3 bucket for the NVIDIA Cloud Account. Requires a bearer token with ''invoke_function'' scope in the HTTP Authorization header. '
+ operationId: createAsset
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateAssetRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CreateAssetResponse'
+ description: OK
+ summary: Create Asset
+ tags:
+ - Asset Management
+ parameters: []
+ /v2/nvcf/assets/{asset_id}:
+ get:
+ deprecated: true
+ description: 'Returns details for the specified asset-id belonging to the current NVIDIA Cloud Account. Requires a bearer token with ''invoke_function'' scope in the HTTP Authorization header. '
+ operationId: getAsset
+ parameters:
+ - description: Asset id
+ in: path
+ name: asset_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AssetResponse'
+ description: OK
+ summary: Show Asset Details
+ tags:
+ - Asset Management
+ delete:
+ deprecated: true
+ description: 'Deletes asset belonging to the current NVIDIA Cloud Account. Requires a bearer token with ''invoke_function'' scope in the HTTP Authorization header. '
+ operationId: deleteAsset
+ parameters:
+ - description: Id of the asset to be deleted
+ in: path
+ name: asset_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '204':
+ description: No Content
+ summary: Delete Asset
+ tags:
+ - Asset Management
+ /v2/nvcf/pexec/functions/{function_id}:
+ post:
+ deprecated: true
+ description: 'Deprecated and will be removed soon. Please use the new NVCF Invocation API endpoint to invoke a function. Invokes the specified function that was successfully deployed. If the version is not specified, any active function versions will handle the request. If the version is specified in the URI, then the request is exclusively processed by the designated version of the function. By default, this endpoint will block for 5 seconds. If the request is not fulfilled before the timeout, it''s status is considered in-progress or pending and the response includes HTTP status code 202 with an invocation request ID, indicating that the client should commence polling for the result using the invocation request ID. Access to this endpoint mandates inclusion of a bearer token with ''invoke_function'' scope in the HTTP Authorization header. Additionally, this endpoint has the capability to provide updates on the progress of the request, contingent upon the workload''s provision of such information. In-progress responses are returned in order. If no in-progress response is received during polling you will receive the most recent in-progress response. Only the first 256 unread in-progress messages are kept. '
+ operationId: invokeFunction
+ parameters:
+ - in: header
+ name: NVCF-INPUT-ASSET-REFERENCES
+ required: false
+ schema:
+ items:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ - in: header
+ name: NVCF-POLL-SECONDS
+ required: false
+ schema:
+ format: int32
+ maximum: 300
+ minimum: 0
+ type: integer
+ nullable: true
+ - in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/StackqlJsonBody'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Invocation is fulfilled
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '202':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Result is pending. Client should poll using the requestId.
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '302':
+ description: |
+ Client should use the URL specified in the 'Location' response header to fetch
+ large result.
+ headers:
+ Location:
+ description: URL to get the result
+ schema:
+ type: string
+ style: simple
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '402':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Cloud credits expired for public functions. Please contact NVIDIA representatives.
+ '403':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ '429':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Client is doing too many requests per second and should slow down request rate.
+ summary: Call Function
+ tags:
+ - Function Invocation
+ /v2/nvcf/pexec/functions/{function_id}/versions/{version_id}:
+ post:
+ deprecated: true
+ description: 'Deprecated and will be removed soon. Please use the new NVCF Invocation API endpoint to invoke a function. Invokes the specified function that was successfully deployed. If the version is not specified, any active function versions will handle the request. If the version is specified in the URI, then the request is exclusively processed by the designated version of the function. By default, this endpoint will block for 5 seconds. If the request is not fulfilled before the timeout, it''s status is considered in-progress or pending and the response includes HTTP status code 202 with an invocation request ID, indicating that the client should commence polling for the result using the invocation request ID. Access to this endpoint mandates inclusion of a bearer token with ''invoke_function'' scope in the HTTP Authorization header. Additionally, this endpoint has the capability to provide updates on the progress of the request, contingent upon the workload''s provision of such information. In-progress responses are returned in order. If no in-progress response is received during polling you will receive the most recent in-progress response. Only the first 256 unread in-progress messages are kept. '
+ operationId: invokeFunction_1
+ parameters:
+ - in: header
+ name: NVCF-INPUT-ASSET-REFERENCES
+ required: false
+ schema:
+ items:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ nullable: true
+ - in: header
+ name: NVCF-POLL-SECONDS
+ required: false
+ schema:
+ format: int32
+ maximum: 300
+ minimum: 0
+ type: integer
+ nullable: true
+ - in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/StackqlJsonBody'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Invocation is fulfilled
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '202':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Result is pending. Client should poll using the requestId.
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '302':
+ description: |
+ Client should use the URL specified in the 'Location' response header to fetch
+ large result.
+ headers:
+ Location:
+ description: URL to get the result
+ schema:
+ type: string
+ style: simple
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '402':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Cloud credits expired for public functions. Please contact NVIDIA representatives.
+ '403':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ '429':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Client is doing too many requests per second and should slow down request rate.
+ summary: Call Function
+ tags:
+ - Function Invocation
+ /v2/nvcf/pexec/status/{request_id}:
+ get:
+ deprecated: true
+ description: 'Deprecated and will be removed soon. Please use the new NVCF Invocation API endpoint to invoke a function and stream results without polling. Retrieves the status of an in-progress or pending request using its unique invocation request ID. If the result is available, it will be included in the response, marking the request as fulfilled. Conversely, if the result is not yet available, the request is deemed pending. Access to this endpoint mandates inclusion of a bearer token with ''invoke_function'' scope in the HTTP Authorization header. In-progress responses are returned in order. If no in-progress response is received during polling you will receive the most recent in-progress response. Only the first 256 unread in-progress messages are kept. '
+ operationId: getFunctionInvocationResult
+ parameters:
+ - description: Invocation Request Id
+ in: path
+ name: request_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Invocation is fulfilled
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '202':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Result is pending. Client should poll using the requestId.
+ headers:
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '302':
+ description: |
+ Client should use the URL specified in the 'Location' response header to fetch
+ large result.
+ headers:
+ Location:
+ description: URL to get the result
+ schema:
+ type: string
+ style: simple
+ NVCF-PERCENT-COMPLETE:
+ description: Percentage complete
+ schema:
+ type: string
+ style: simple
+ NVCF-REQID:
+ description: Invocation Request Id
+ schema:
+ type: string
+ style: simple
+ NVCF-STATUS:
+ description: Invocation status
+ schema:
+ type: string
+ style: simple
+ '402':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: Cloud credits expired for public functions. Please contact NVIDIA representatives.
+ '403':
+ content:
+ application/json:
+ schema:
+ properties:
+ char:
+ type: string
+ direct:
+ type: boolean
+ double:
+ format: double
+ type: number
+ float:
+ format: float
+ type: number
+ int:
+ format: int32
+ type: integer
+ long:
+ format: int64
+ type: integer
+ readOnly:
+ type: boolean
+ short:
+ format: int32
+ type: integer
+ type: object
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ summary: Poll For Result Using Function Invocation Request
+ tags:
+ - Function Invocation
+ /v2/nvcf/tokens/functions:
+ post:
+ description: 'Issues an assertion token from Notary Service for specified functionIds and/or functionVersionIds '
+ operationId: issueMultiFunctionsInvocationToken
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/MultiFunctionsInvocationTokenRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Invocation assertion token is issued
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Client is doing too many requests per second and should slow down request rate.
+ summary: Issue Function Invocation Token
+ tags:
+ - Function Invocation Assertion Token
+ parameters: []
+ /v2/nvcf/tokens/functions/{function_id}:
+ post:
+ description: 'Issues an assertion token from Notary Service for a specific functionId and/or functionVersionId '
+ operationId: issueInvocationToken_1
+ parameters:
+ - in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Invocation assertion token is issued
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Client is doing too many requests per second and should slow down request rate.
+ summary: Issue Function Invocation Token
+ tags:
+ - Function Invocation Assertion Token
+ /v2/nvcf/tokens/functions/{function_id}/versions/{function_version_id}:
+ post:
+ description: 'Issues an assertion token from Notary Service for a specific functionId and/or functionVersionId '
+ operationId: issueInvocationToken
+ parameters:
+ - in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: function_version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Invocation assertion token is issued
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: |
+ Either missing scope in the auth(JWT / ApiKey) token and/or missing resource entry
+ in the ApiKey for the function.
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/InvocationTokenResponse'
+ description: Client is doing too many requests per second and should slow down request rate.
+ summary: Issue Function Invocation Token
+ tags:
+ - Function Invocation Assertion Token
+components:
+ schemas:
+ ListAssetsResponse:
+ description: Response body containing list of assets of the current nca id
+ properties:
+ assets:
+ description: List of assets uploaded for the nca id
+ items:
+ $ref: '#/components/schemas/AssetDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - assets
+ type: object
+ CreateAssetRequest:
+ description: Request payload to create an asset-id and the corresponding pre-signed URL to upload an asset of specified content-type to AWS S3 bucket.
+ properties:
+ contentType:
+ description: Content type of the asset such image/png, image/jpeg, etc.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ description:
+ description: Asset description
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ required:
+ - contentType
+ - description
+ type: object
+ CreateAssetResponse:
+ description: Response body containing asset-id and the corresponding pre-signed URL to upload an asset of specified content-type to AWS S3 bucket.
+ properties:
+ assetId:
+ description: Unique id of the asset to be uploaded to AWS S3 bucket
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ contentType:
+ description: Content type of the asset such image/png, image/jpeg, etc.
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ description:
+ description: Asset description to be used when uploading the asset
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ uploadUrl:
+ description: Pre-signed upload URL to upload asset
+ format: url
+ type: string
+ required:
+ - assetId
+ - contentType
+ - description
+ - uploadUrl
+ type: object
+ AssetResponse:
+ properties:
+ asset:
+ $ref: '#/components/schemas/AssetDto'
+ required:
+ - asset
+ type: object
+ MultiFunctionsInvocationTokenRequest:
+ description: Request body for issuing a function invocation token
+ properties:
+ clientId:
+ description: ClientId for client to pass in to track who will eventually use the token
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ functions:
+ description: Functions to invoke
+ items:
+ $ref: '#/components/schemas/BasicFunctionDto'
+ maxItems: 4
+ minItems: 0
+ type: array
+ required:
+ - clientId
+ - functions
+ type: object
+ InvocationTokenResponse:
+ description: Function invocation token response
+ properties:
+ access_token:
+ description: Token issued by Notary Service
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ expires_in:
+ description: Token expiration time in seconds
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ type: object
+ InvocationTokenRequest:
+ description: Request body for issuing a function invocation token
+ properties:
+ clientId:
+ description: ClientId for client to pass in to track who will eventually use the token
+ format: UTF-8
+ maxLength: 262144
+ minLength: 1
+ type: string
+ required:
+ - clientId
+ type: object
+ AssetDto:
+ description: Data Transfer Object(DTO) representing an asset
+ properties:
+ assetId:
+ description: Asset id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ contentType:
+ description: Content-type specified when creating the asset
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ createdAt:
+ description: Timestamp specified when creating the asset
+ format: date-time
+ maxLength: 30
+ minLength: 8
+ type: string
+ nullable: true
+ description:
+ description: Description specified when creating the asset
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ nullable: true
+ type: object
+ BasicFunctionDto:
+ description: Basic Data Transfer Object (DTO) representing a function
+ properties:
+ functionId:
+ description: Unique function id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ functionVersionId:
+ description: Unique function version id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ nullable: true
+ required:
+ - functionId
+ type: object
+ StackqlJsonBody:
+ type: object
+ description: A free-form JSON request body, supplied as a JSON string in the body argument
+ properties:
+ body:
+ type: string
+ description: The request payload as a JSON string (the function input)
+ required:
+ - body
+ StackqlInvocationResult:
+ type: object
+ properties:
+ results:
+ type: array
+ items:
+ type: object
+ properties:
+ response:
+ type: string
+ description: The invocation response body as returned by the function (JSON text); empty while the request is still pending (HTTP 202)
+ x-stackQL-resources:
+ assets:
+ id: nvidia.nvcf_invocation.assets
+ name: assets
+ title: Assets
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1assets/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.assets
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1assets/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1assets~1{asset_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.asset
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1assets~1{asset_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '204'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/assets/methods/get'
+ - $ref: '#/components/x-stackQL-resources/assets/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/assets/methods/create'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/assets/methods/delete'
+ replace: []
+ invocations:
+ id: nvidia.nvcf_invocation.invocations
+ name: invocations
+ title: Invocations
+ methods:
+ invoke:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1pexec~1functions~1{function_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ mediaType: application/json
+ transform:
+ type: golang_template_json_v0.3.0
+ body: '{{ if eq (kindOf .body) "string" }}{{ .body }}{{ else }}{{ toJson .body }}{{ end }}'
+ invoke_version:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1pexec~1functions~1{function_id}~1versions~1{version_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ mediaType: application/json
+ transform:
+ type: golang_template_json_v0.3.0
+ body: '{{ if eq (kindOf .body) "string" }}{{ .body }}{{ else }}{{ toJson .body }}{{ end }}'
+ sqlVerbs:
+ select: []
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ invocation_status:
+ id: nvidia.nvcf_invocation.invocation_status
+ name: invocation_status
+ title: Invocation Status
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1pexec~1status~1{request_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ overrideMediaType: application/json
+ schema_override:
+ $ref: '#/components/schemas/StackqlInvocationResult'
+ objectKey: $.results
+ transform:
+ type: golang_template_text_v0.3.0
+ body: '{"results": [{"response": {{ toJson . }}}]}'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/invocation_status/methods/get'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ tokens:
+ id: nvidia.nvcf_invocation.tokens
+ name: tokens
+ title: Tokens
+ methods:
+ create_for_functions:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1tokens~1functions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_for_function:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1tokens~1functions~1{function_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_for_version:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1tokens~1functions~1{function_id}~1versions~1{function_version_id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update: []
+ delete: []
+ replace: []
+servers:
+ - url: https://api.nvcf.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/nvcf_queues.yaml b/providers/src/nvidia/v00.00.00000/services/nvcf_queues.yaml
new file mode 100644
index 00000000..930da523
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/nvcf_queues.yaml
@@ -0,0 +1,228 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA Cloud Functions - Queues
+ description: NVCF request queue details per function and version, and queue position per request (served from api.nvcf.nvidia.com).
+ version: 2.261.2
+paths:
+ /v2/nvcf/queues/functions/{function_id}:
+ get:
+ description: 'Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with ''queue_details'' scope in the HTTP Authorization header. '
+ operationId: getQueuesDetails_1
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetQueuesResponse'
+ description: OK
+ summary: Queue Details
+ tags:
+ - Queue Details
+ /v2/nvcf/queues/functions/{function_id}/versions/{version_id}:
+ get:
+ description: 'Provides details of all the queues associated with the specified function. If a function has multiple versions and they are all deployed, then the response includes details of all the queues. If the specified function is public, then Account Admin cannot perform this operation. Requires a bearer token or an api-key with ''queue_details'' scope in the HTTP Authorization header. '
+ operationId: getQueuesDetails
+ parameters:
+ - description: Function id
+ in: path
+ name: function_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ - description: Function version id
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetQueuesResponse'
+ description: OK
+ summary: Queue Details
+ tags:
+ - Queue Details
+ /v2/nvcf/queues/{request_id}/position:
+ get:
+ description: 'Using the specified function invocation request id, returns the estimated position of the corresponding message up to 1000 in the queue. Requires a bearer token or an api-key with ''queue_details'' scope in the HTTP Authorization header. '
+ operationId: getPositionInQueue
+ parameters:
+ - description: Function invocation request id
+ in: path
+ name: request_id
+ required: true
+ schema:
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetPositionInQueueResponse'
+ description: OK
+ summary: Queue Position
+ tags:
+ - Queue Details
+components:
+ schemas:
+ GetQueuesResponse:
+ description: Request queue details of all the functions with same id in an account
+ properties:
+ functionId:
+ description: Function id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ queues:
+ description: Details of all the queues associated with same named functions
+ items:
+ $ref: '#/components/schemas/QueueDto'
+ maxItems: 2147483647
+ minItems: 0
+ type: array
+ required:
+ - functionId
+ - queues
+ type: object
+ GetPositionInQueueResponse:
+ description: Request position in queue for invocation request
+ properties:
+ functionId:
+ description: Function id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ functionVersionId:
+ description: Function version id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ positionInQueue:
+ description: Position of request in queue
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ required:
+ - functionId
+ - functionVersionId
+ type: object
+ QueueDto:
+ description: Data Transfer Object(DTO) representing a request queue for function version
+ properties:
+ functionName:
+ description: Function name
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ functionStatus:
+ description: Function status
+ enum:
+ - ACTIVE
+ - DEPLOYING
+ - ERROR
+ - INACTIVE
+ - DELETED
+ - DEGRADED
+ - DEGRADING
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ functionVersionId:
+ description: Function version id
+ format: uuid
+ maxLength: 36
+ minLength: 36
+ type: string
+ queueDepth:
+ description: Approximate number of messages in the request queue
+ format: int32
+ maximum: 2147483647
+ minimum: -2147483648
+ type: integer
+ required:
+ - functionName
+ - functionStatus
+ - functionVersionId
+ type: object
+ x-stackQL-resources:
+ queues:
+ id: nvidia.nvcf_queues.queues
+ name: queues
+ title: Queues
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1queues~1functions~1{function_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.queues
+ request:
+ nativeCasing: camel
+ list_version:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1queues~1functions~1{function_id}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.queues
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/queues/methods/list_version'
+ - $ref: '#/components/x-stackQL-resources/queues/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ queue_positions:
+ id: nvidia.nvcf_queues.queue_positions
+ name: queue_positions
+ title: Queue Positions
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1nvcf~1queues~1{request_id}~1position/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/queue_positions/methods/get'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+servers:
+ - url: https://api.nvcf.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/orgs.yaml b/providers/src/nvidia/v00.00.00000/services/orgs.yaml
new file mode 100644
index 00000000..7324c454
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/orgs.yaml
@@ -0,0 +1,6214 @@
+openapi: 3.0.1
+info:
+ title: NVIDIA NGC Organizations
+ description: 'NGC organizations, teams, users and team members, role grants, invitations and the current user (source: the NGC API definition harvested from the API explorer).'
+ version: v3.249.17
+paths:
+ /roles:
+ get:
+ description: List of roles in NGC and their scopes
+ operationId: getRoles
+ parameters:
+ - description: flag indicate if hidden roles should be included
+ in: query
+ name: show-hidden
+ required: false
+ schema:
+ default: false
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserRoleDefinitionsResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: NGC Roles
+ tags:
+ - Services
+ /starfleetIds/{starfleet_id}:
+ get:
+ description: Get User details in org by starfleet Id
+ operationId: getUserInOrg_1
+ parameters:
+ - in: path
+ name: starfleet_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get User in org
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/starfleetIds/{starfleet_id}:
+ get:
+ description: Get User details in team by starfleet Id
+ operationId: getUserInTeamByStarfleetId
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: starfleet_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get User in team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/users:
+ get:
+ description: Get list of users in team. (User Admin in team privileges required)
+ operationId: listUsersInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are implemented
+ in: query
+ name: q
+ required: false
+ schema:
+ $ref: '#/components/schemas/SearchParams'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List users in team
+ tags:
+ - Users Management
+ post:
+ description: Creates a User and add them to a team within the org.
+ operationId: createUserInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: send-email
+ required: false
+ schema:
+ default: true
+ type: boolean
+ - description: If the IDP ID is provided then it is used instead of the one configured for the organization
+ in: query
+ name: idp-id
+ required: false
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Creates a User in team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/users/invitations:
+ get:
+ description: List invitations in a team. (Team User Admin privileges required)
+ operationId: listInvitationsForUserInTeam
+ parameters:
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - in: query
+ name: orderBy
+ required: false
+ schema:
+ enum:
+ - NAME_ASC
+ - NAME_DESC
+ type: string
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - description: User Search Parameters
+ in: query
+ name: q
+ required: false
+ schema:
+ $ref: '#/components/schemas/SearchParams'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserInvitationListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List user invitations in a team.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/users/invitations/{id}:
+ delete:
+ description: Delete a specific invitation in an team. (Org Admin or Team User Admin privileges required)
+ operationId: deleteUserInvitationInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Delete a specific invitation in a team.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/users/invitations/{id}/resend-invitation-email:
+ get:
+ description: Resend email of a specific invitation in a team (Org or Team User Admin privileges required).
+ operationId: resendUserInvitationEmailInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Resend email of a specific invitation in a team.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/users/{id}:
+ post:
+ description: Add a User to team
+ operationId: addUserToTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Add a User to team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams:
+ get:
+ description: List all Teams
+ operationId: listTeams
+ parameters:
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List Teams
+ tags:
+ - Teams
+ post:
+ description: Create team in org. (Org Admin Privileges Required)
+ operationId: createTeam
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamCreateResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Create Team
+ tags:
+ - Teams
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams/{team_name}:
+ get:
+ description: Get Team by name
+ operationId: getTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get Team
+ tags:
+ - Teams
+ patch:
+ description: Edit a Team
+ operationId: editTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/TeamResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Edit Team
+ tags:
+ - Teams
+ delete:
+ description: Delete a Team
+ operationId: deleteTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Delete Team
+ tags:
+ - Teams
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users:
+ get:
+ description: Get list of users in organization. (User Admin in org privileges required)
+ operationId: listUsersInOrg
+ parameters:
+ - description: Name of team to exclude members from
+ in: query
+ name: exclude-from-team
+ required: false
+ schema:
+ type: string
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: User Search Parameters. Only 'filters' and 'orderBy' for 'name' and 'email' are implemented
+ in: query
+ name: q
+ required: false
+ schema:
+ $ref: '#/components/schemas/SearchParams'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List users In org
+ tags:
+ - Users Management
+ post:
+ description: Creates a User
+ operationId: createUserInOrg
+ parameters:
+ - in: query
+ name: send-email
+ required: false
+ schema:
+ default: true
+ type: boolean
+ - description: If the IDP ID is provided then it is used instead of the one configured for the organization
+ in: query
+ name: idp-id
+ required: false
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Creates a User in org
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/invitations:
+ get:
+ description: List invitations in an org. (Org User Admin privileges required)
+ operationId: listInvitationsForUserInOrg
+ parameters:
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - in: query
+ name: orderBy
+ required: false
+ schema:
+ enum:
+ - NAME_ASC
+ - NAME_DESC
+ type: string
+ - description: User Search Parameters
+ in: query
+ name: q
+ required: false
+ schema:
+ $ref: '#/components/schemas/SearchParams'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserInvitationListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List user invitations in an org.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/invitations/{id}:
+ delete:
+ description: Delete a specific invitation in an org. (Org User Admin privileges required)
+ operationId: deleteUserInvitationInOrg
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Delete a specific invitation in an org.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/invitations/{id}/resend-invitation-email:
+ get:
+ description: Resend email of a specific invitation in an org (Org User Admin privileges required).
+ operationId: resendUserInvitationEmailInOrg
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Resend email of a specific invitation in an org.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /v2/orgs:
+ get:
+ description: List all organizations of the user
+ operationId: listOrganizations_1
+ parameters:
+ - description: The page number of result
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: int32
+ type: integer
+ - description: The page size of result
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: int32
+ type: integer
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgListResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: List Organizations
+ tags:
+ - Orgs
+ /v2/orgs/{org_name}:
+ get:
+ description: Get organization information
+ operationId: getOrganization
+ parameters:
+ - in: path
+ name: org_name
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get Organization
+ tags:
+ - Orgs
+ patch:
+ description: Update organization information
+ operationId: updateOrganization
+ parameters:
+ - in: path
+ name: org_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgProfileUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Update Organization
+ tags:
+ - Orgs
+ /v2/users/me:
+ get:
+ description: What am I?
+ operationId: whoAmI
+ parameters:
+ - in: query
+ name: org-name
+ required: false
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Who am I?
+ tags:
+ - Users Management
+ patch:
+ description: Edit current user profile
+ operationId: editUserProfile
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Edit current user profile
+ tags:
+ - Users Management
+ parameters: []
+ /v2/users/me/api-key:
+ post:
+ description: Generate API Key
+ operationId: generateUserApiKey
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserKeyResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Generate API Key
+ tags:
+ - Users Management
+ parameters: []
+ /v3/orgs:
+ post:
+ description: Create a new organization based on the org info provided in the request.
+ operationId: createOrganizationFromScratch
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgCreateRequestV3'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Create Organization from Scratch
+ tags:
+ - Orgs
+ /v3/orgs/proto-org:
+ post:
+ description: Create a new organization based on the org info retrieved from the ProtoOrg.
+ operationId: createOrganizationFromProtoOrg
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgCreateRequestV3'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Create Organization from ProtoOrg
+ tags:
+ - Orgs
+ /v3/orgs/proto-org/validate:
+ get:
+ description: Validate org creation from proto org
+ operationId: protoOrgInvitationValidate
+ parameters:
+ - description: JWT that contains org owner email and proto org identifier
+ in: query
+ name: invitation_token
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OrgInvitationResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Validate org creation invite
+ tags:
+ - Orgs
+ /teams/{team_name}/users/nca-invitations:
+ post:
+ description: Invites and creates a User in team
+ operationId: inviteUserToNcaInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserNcaInvitationRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Invite User to NCA (team version)
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams/{team_name}/users/{id}:
+ delete:
+ description: Remove User from team.
+ operationId: removeUserFromTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ - description: If anonymize is true, then org owner permission is required.
+ in: query
+ name: anonymize
+ required: false
+ schema:
+ default: false
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Remove User from team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams/{team_name}/users/{user_email_or_id}:
+ get:
+ description: Get info and role/invitation in a team by email or id
+ operationId: listUserRolesInOrgTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get user in a team by email or id.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams/{team_name}/users/{user_email_or_id}/add-role:
+ patch:
+ description: Invite if user does not exist, otherwise add role in team
+ operationId: addRoleOrInviteUserToTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: roles
+ required: true
+ schema:
+ items:
+ type: string
+ type: array
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Invite user or add role in team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /teams/{team_name}/users/{user_email_or_id}/remove-role:
+ delete:
+ description: Remove role in team if user exists, otherwise remove invitation
+ operationId: removeRoleOrInvitationInTeam
+ parameters:
+ - in: path
+ name: team_name
+ required: true
+ schema:
+ type: string
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: roles
+ required: false
+ schema:
+ items:
+ type: string
+ type: array
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Remove role or invitation in team
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/nca-invitations:
+ post:
+ description: Invites and creates a User in org
+ operationId: inviteUserToNcaInOrg
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserNcaInvitationRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Invite User to NCA (org version)
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/{id}:
+ delete:
+ description: Remove User from org.
+ operationId: removeUserFromOrg
+ parameters:
+ - in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ - description: If anonymize is true, then org owner permission is required.
+ in: query
+ name: anonymize
+ required: false
+ schema:
+ default: false
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Remove User from org
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/{user_email_or_id}:
+ get:
+ description: Get info and role/invitation in an org by email or id
+ operationId: listUserRolesInOrg
+ parameters:
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Get user in an org by email or id.
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/{user_email_or_id}/add-role:
+ patch:
+ description: Invite if user does not exist, otherwise add role in org
+ operationId: addRoleOrInviteUserToOrg
+ parameters:
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: roles
+ required: true
+ schema:
+ items:
+ type: string
+ type: array
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Invite user or add role in org
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /users/{user_email_or_id}/remove-role:
+ delete:
+ description: Remove role in org if user exists, otherwise remove invitation
+ operationId: removeRoleOrInvitationInOrg
+ parameters:
+ - in: path
+ name: user_email_or_id
+ required: true
+ schema:
+ type: string
+ - in: query
+ name: roles
+ required: false
+ schema:
+ items:
+ type: string
+ type: array
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UserResponse'
+ description: OK
+ '302':
+ description: Found
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unauthorized
+ '402':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Payment Required
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Found
+ '405':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Method Not Allowed
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Object Exists
+ '415':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unsupported Media Type
+ '422':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Unprocessable Entity
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Too Many Requests
+ '451':
+ description: Unavailable For Legal Reasons
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Internal Error
+ '501':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Not Implemented
+ '502':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Bad Gateway
+ '503':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ description: Service Unavailable
+ summary: Remove role or invitation in org
+ tags:
+ - Users Management
+ servers:
+ - url: https://api.ngc.nvidia.com/v3/orgs/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+components:
+ schemas:
+ UserRoleDefinitionsResponse:
+ description: Response containing all the roles defined in NGC and their allowed actions
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ roles:
+ description: List of roles
+ items:
+ $ref: '#/components/schemas/UserRoleDefinition'
+ type: array
+ type: object
+ ErrorResponse:
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ UserResponse:
+ description: ' about one user'
+ properties:
+ activationToken:
+ description: token needed to activate the user to enable login and other features
+ type: string
+ ncaRole:
+ description: NCA role
+ enum:
+ - UNKNOWN
+ - ADMINISTRATOR
+ - MEMBER
+ - OWNER
+ - PENDING
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ user:
+ $ref: '#/components/schemas/User'
+ userRoles:
+ description: DEPRECATED - Please use roles inside user
+ items:
+ $ref: '#/components/schemas/UserRole'
+ type: array
+ type: object
+ SearchParams:
+ properties:
+ fields:
+ items:
+ type: string
+ type: array
+ filters:
+ items:
+ $ref: '#/components/schemas/SearchParamFilter'
+ type: array
+ groupBy:
+ type: string
+ orderBy:
+ items:
+ $ref: '#/components/schemas/SearchParamOrderBy'
+ type: array
+ page:
+ format: int64
+ type: integer
+ pageSize:
+ format: int64
+ type: integer
+ query:
+ type: string
+ queryFields:
+ items:
+ type: string
+ type: array
+ scoredSize:
+ format: int64
+ type: integer
+ type: object
+ UserListResponse:
+ description: Response for List User reponse
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ users:
+ description: information about the user
+ items:
+ $ref: '#/components/schemas/User'
+ type: array
+ type: object
+ UserCreateRequest:
+ description: object used request user creation in an existing org
+ properties:
+ email:
+ description: Email address of the user. This should be unique.
+ maxLength: 128
+ minLength: 6
+ type: string
+ emailOptIn:
+ description: indicates if user has opt in to nvidia emails
+ type: boolean
+ eulaAccepted:
+ description: indicates if user has accepted EULA
+ type: boolean
+ name:
+ description: user name
+ maxLength: 64
+ minLength: 1
+ type: string
+ roleType:
+ description: DEPRECATED - use roleTypes which allows multiple roles
+ type: string
+ roleTypes:
+ description: feature roles to give to the user
+ items:
+ description: feature roles to give to the user
+ type: string
+ type: array
+ salesforceContactJobRole:
+ description: user job role
+ type: string
+ userMetadata:
+ $ref: '#/components/schemas/UserMetadata'
+ required:
+ - email
+ type: object
+ UserInvitationListResponse:
+ description: Response for a list of user invitations.
+ properties:
+ invitations:
+ description: List of invitations.
+ items:
+ $ref: '#/components/schemas/UserInvitation'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ Response:
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ TeamListResponse:
+ description: listing of all teams
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ teams:
+ items:
+ $ref: '#/components/schemas/Team'
+ type: array
+ type: object
+ TeamCreateRequest:
+ description: Request to create new Team
+ properties:
+ description:
+ description: description of the team
+ maxLength: 255
+ type: string
+ name:
+ description: team name
+ maxLength: 19
+ minLength: 2
+ type: string
+ required:
+ - name
+ type: object
+ TeamCreateResponse:
+ description: response to an team creation request, includes unique team id
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ team:
+ $ref: '#/components/schemas/Team'
+ type: object
+ TeamResponse:
+ description: details about one team
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ team:
+ $ref: '#/components/schemas/Team'
+ type: object
+ TeamUpdateRequest:
+ description: object used to update information about existing team
+ properties:
+ description:
+ description: description of the team
+ maxLength: 255
+ type: string
+ infinityManagerSettings:
+ $ref: '#/components/schemas/InfinityManagerSettings'
+ repoScanSettings:
+ $ref: '#/components/schemas/RepoScanSettings'
+ type: object
+ OrgListResponse:
+ description: List of organizations.
+ properties:
+ organizations:
+ items:
+ $ref: '#/components/schemas/Organization'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ OrgResponse:
+ description: info about an organizations
+ properties:
+ organizations:
+ $ref: '#/components/schemas/Organization'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ OrgProfileUpdateRequest:
+ description: Object used to update Org profile information
+ properties:
+ description:
+ description: optional description of the organization
+ maxLength: 128
+ type: string
+ displayName:
+ description: Name of the organization that will be shown to users
+ maxLength: 255
+ minLength: 1
+ type: string
+ type: object
+ UserUpdateRequest:
+ description: object used to request user update
+ properties:
+ hasEmailOptIn:
+ description: indicates if user has opt in to nvidia emails
+ type: boolean
+ hasSignedAODTEULA:
+ description: indicates if user has accepted AODT End User License Agreement.
+ type: boolean
+ hasSignedAiFoundryPartnershipsEULA:
+ description: indicates if user has accepted AI Foundry Partnerships End User License Agreement.
+ type: boolean
+ hasSignedBaseCommandEULA:
+ description: indicates if user has accepted Base Command EULA
+ type: boolean
+ hasSignedBaseCommandManagerEULA:
+ description: indicates if user has accepted Base Command Manager End User License Agreement.
+ type: boolean
+ hasSignedBioNeMoEULA:
+ description: indicates if user has accepted BioNeMo End User License Agreement.
+ type: boolean
+ hasSignedContainerPublishingEULA:
+ description: indicates if user has accepted container publishing eula
+ type: boolean
+ hasSignedCuOptEULA:
+ description: indicates if user has accepted CuOpt End User License Agreement.
+ type: boolean
+ hasSignedEULA:
+ description: indicates if user has accepted NGC EULA
+ type: boolean
+ hasSignedEarth2EULA:
+ description: indicates if user has accepted Earth-2 End User License Agreement.
+ type: boolean
+ hasSignedEgxEULA:
+ description: indicates if user has accepted EGX EULA
+ type: boolean
+ hasSignedFleetCommandEULA:
+ description: indicates if user has accepted Fleet Command End User License Agreement.
+ type: boolean
+ hasSignedLlmEULA:
+ description: indicates if user has accepted LLM End User License Agreement.
+ type: boolean
+ hasSignedNVAIEEULA:
+ description: indicates if user has accepted Fleet Command End User License Agreement.
+ type: boolean
+ hasSignedNVQCEULA:
+ description: indicates if user has accepted Nvidia Quantum Cloud End User License Agreement.
+ type: boolean
+ hasSignedNvidiaEULA:
+ description: indicates if user has accepted NVIDIA EULA
+ type: boolean
+ hasSignedOmniverseEULA:
+ description: indicates if user has accepted Omniverse End User License Agreement.
+ type: boolean
+ hasSignedPrivacyPolicy:
+ description: indicates if the user has signed the Privacy Policy
+ type: boolean
+ hasSignedThirdPartyRegistryShareEULA:
+ description: indicates if user has consented to share their registration info with other parties
+ type: boolean
+ name:
+ description: user name
+ maxLength: 64
+ minLength: 1
+ type: string
+ userMetadata:
+ $ref: '#/components/schemas/UserMetadata'
+ type: object
+ UserKeyResponse:
+ description: response to a request to access key such as docker token
+ properties:
+ cloudNfsKey:
+ type: string
+ cloudNfsKeyPwd:
+ type: string
+ cloudNfsUserName:
+ type: string
+ key:
+ maxLength: 255
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ required:
+ - key
+ type: object
+ OrgCreateRequestV3:
+ description: Request to create new Organization in v3 flow
+ properties:
+ country:
+ description: user country
+ type: string
+ description:
+ description: optional description of the organization
+ maxLength: 128
+ type: string
+ displayName:
+ description: Name of the organization that will be shown to users.
+ maxLength: 255
+ minLength: 1
+ type: string
+ initiator:
+ description: Identify the initiator of the org request
+ type: string
+ isInternal:
+ description: Is NVIDIA internal org or not
+ type: boolean
+ name:
+ description: Organization name
+ maxLength: 64
+ minLength: 2
+ type: string
+ ncaId:
+ description: NVIDIA Cloud Account Identifier
+ type: string
+ ncaNumber:
+ description: NVIDIA Cloud Account Number
+ type: string
+ orgOwner:
+ $ref: '#/components/schemas/OrgOwnerV3'
+ pecName:
+ description: product end customer name for enterprise(Fleet Command) product
+ type: string
+ pecSfdcId:
+ description: product end customer salesforce.com Id (external customer Id) for enterprise(Fleet Command) product
+ type: string
+ productEnablements:
+ items:
+ $ref: '#/components/schemas/ProductEnablement'
+ type: array
+ productSubscriptions:
+ description: This should be deprecated, use productEnablements instead
+ items:
+ $ref: '#/components/schemas/ProductSubscription'
+ type: array
+ protoOrgId:
+ description: Proto org identifier
+ type: string
+ salesforceAccountIndustry:
+ description: Company or organization industry
+ type: string
+ sendEmail:
+ description: Send email to org owner or not. Default is true
+ type: boolean
+ type:
+ enum:
+ - UNKNOWN
+ - CLOUD
+ - ENTERPRISE
+ - INDIVIDUAL
+ type: string
+ type: object
+ OrgInvitationResponse:
+ description: Invitation Validation Response.
+ properties:
+ orgInvitation:
+ $ref: '#/components/schemas/OrgInvitation'
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ type: object
+ UserNcaInvitationRequest:
+ description: NCA User invitation request
+ properties:
+ email:
+ description: Is the user email
+ maxLength: 128
+ minLength: 7
+ type: string
+ invitationExpirationIn:
+ description: Is the numbers of days the invitation will expire
+ format: int32
+ type: integer
+ inviteAs:
+ description: Nca allow users to be invited as Admin and as Member
+ enum:
+ - ADMIN
+ - MEMBER
+ type: string
+ message:
+ description: Is a message to the new user
+ type: string
+ type: object
+ RequestStatus:
+ properties:
+ requestId:
+ type: string
+ serverId:
+ type: string
+ statusCode:
+ description: Describes response status reported by the server.
+ enum:
+ - UNKNOWN
+ - SUCCESS
+ - UNAUTHORIZED
+ - PAYMENT_REQUIRED
+ - FORBIDDEN
+ - TIMEOUT
+ - EXISTS
+ - NOT_FOUND
+ - INTERNAL_ERROR
+ - INVALID_REQUEST
+ - INVALID_REQUEST_VERSION
+ - INVALID_REQUEST_DATA
+ - METHOD_NOT_ALLOWED
+ - CONFLICT
+ - UNPROCESSABLE_ENTITY
+ - TOO_MANY_REQUESTS
+ - INSUFFICIENT_STORAGE
+ - SERVICE_UNAVAILABLE
+ - PAYLOAD_TOO_LARGE
+ - NOT_ACCEPTABLE
+ - UNAVAILABLE_FOR_LEGAL_REASONS
+ - BAD_GATEWAY
+ - PRECONDITION_FAILED
+ type: string
+ statusDescription:
+ type: string
+ type: object
+ UserRoleDefinition:
+ description: List of roles
+ properties:
+ allowedActions:
+ description: List of actions that this role allows
+ items:
+ $ref: '#/components/schemas/ServiceAccess'
+ type: array
+ displayName:
+ description: Display Name of the role
+ type: string
+ name:
+ description: Name of the role
+ type: string
+ product:
+ $ref: '#/components/schemas/RoleProduct'
+ shortDisplayName:
+ description: Short Display Name of the role
+ type: string
+ type: object
+ User:
+ description: information about the user
+ properties:
+ clientId:
+ description: unique auth client id of this user.
+ type: string
+ createdDate:
+ description: Created date for this user
+ type: string
+ email:
+ description: Email address of the user. This should be unique.
+ maxLength: 128
+ minLength: 7
+ type: string
+ firstLoginDate:
+ description: Last time the user logged in
+ type: string
+ hasBetaAccess:
+ description: Determines if the user has beta access
+ type: boolean
+ hasProfile:
+ description: indicate if user profile has been completed.
+ type: boolean
+ hasSignedAODTEULA:
+ description: indicates if user has accepted AODT End User License Agreement.
+ type: boolean
+ hasSignedAiFoundryPartnershipsEULA:
+ description: indicates if user has accepted AI Foundry Partnerships eula
+ type: boolean
+ hasSignedBaseCommandEULA:
+ description: indicates if user has accepted Base Command End User License Agreement.
+ type: boolean
+ hasSignedBaseCommandManagerEULA:
+ description: indicates if user has accepted Base Command Manager End User License Agreement.
+ type: boolean
+ hasSignedBioNeMoEULA:
+ description: indicates if user has accepted BioNeMo End User License Agreement.
+ type: boolean
+ hasSignedContainerPublishingEULA:
+ description: indicates if user has accepted container publishing eula
+ type: boolean
+ hasSignedCuOptEULA:
+ description: indicates if user has accepted CuOpt eula
+ type: boolean
+ hasSignedEULA:
+ description: Determines if the user has signed the NGC End User License Agreement.
+ type: boolean
+ hasSignedEarth2EULA:
+ description: indicates if user has accepted Earth-2 eula
+ type: boolean
+ hasSignedEgxEULA:
+ description: '[Deprecated] indicates if user has accepted EGX End User License Agreement.'
+ type: boolean
+ hasSignedFleetCommandEULA:
+ description: indicates if user has accepted Fleet Command End User License Agreement.
+ type: boolean
+ hasSignedLlmEULA:
+ description: indicates if user has accepted LLM End User License Agreement.
+ type: boolean
+ hasSignedNVAIEEULA:
+ description: indicates if user has accepted Fleet Command End User License Agreement.
+ type: boolean
+ hasSignedNVQCEULA:
+ description: indicates if user has accepted Nvidia Quantum Cloud End User License Agreement.
+ type: boolean
+ hasSignedNvidiaEULA:
+ description: Determines if the user has signed the NVIDIA End User License Agreement.
+ type: boolean
+ hasSignedOmniverseEULA:
+ description: indicates if user has accepted Omniverse End User License Agreement.
+ type: boolean
+ hasSignedPrivacyPolicy:
+ description: Determines if the user has signed the Privacy Policy.
+ type: boolean
+ hasSignedThirdPartyRegistryShareEULA:
+ description: indicates if user has consented to share their registration info with other parties
+ type: boolean
+ hasSubscribedToEmail:
+ description: Determines if the user has opted in email subscription.
+ type: boolean
+ id:
+ description: unique Id of this user.
+ format: int64
+ type: integer
+ idpType:
+ description: Type of IDP, Identity Provider. Used for login.
+ enum:
+ - NVIDIA
+ - ENTERPRISE
+ type: string
+ isActive:
+ description: Determines if the user is active or not.
+ type: boolean
+ isDeleted:
+ description: Indicates if user was deleted from the system.
+ type: boolean
+ isSAML:
+ description: Determines if the user is a SAML account or not.
+ type: boolean
+ jobPositionTitle:
+ description: Title of user's job position.
+ type: string
+ lastLoginDate:
+ description: Last time the user logged in
+ type: string
+ name:
+ description: user name
+ maxLength: 64
+ minLength: 1
+ type: string
+ roles:
+ description: List of roles that the user have
+ items:
+ $ref: '#/components/schemas/UserRole'
+ type: array
+ starfleetId:
+ description: unique starfleet id of this user.
+ type: string
+ storageQuota:
+ description: Storage quota for this user.
+ items:
+ $ref: '#/components/schemas/UserStorageQuota'
+ type: array
+ updatedDate:
+ description: Updated date for this user
+ type: string
+ userMetadata:
+ $ref: '#/components/schemas/UserMetadata'
+ verified:
+ description: Is user's email or phone number is verified
+ type: boolean
+ type: object
+ UserRole:
+ description: List of roles that the user have
+ properties:
+ org:
+ $ref: '#/components/schemas/Organization'
+ orgRoles:
+ description: List of org role types that the user have
+ items:
+ description: List of org role types that the user have
+ type: string
+ type: array
+ roleTypes:
+ description: DEPRECATED - List of role types that the user have
+ items:
+ description: DEPRECATED - List of role types that the user have
+ type: string
+ type: array
+ targetSystemUserIdentifier:
+ $ref: '#/components/schemas/TargetSystemUserIdentifier'
+ team:
+ $ref: '#/components/schemas/Team'
+ teamRoles:
+ description: List of team role types that the user have
+ items:
+ description: List of team role types that the user have
+ type: string
+ type: array
+ type: object
+ SearchParamFilter:
+ properties:
+ field:
+ type: string
+ value:
+ type: string
+ type: object
+ SearchParamOrderBy:
+ properties:
+ field:
+ type: string
+ value:
+ enum:
+ - ASC
+ - DESC
+ type: string
+ type: object
+ PaginationInfo:
+ description: object that describes the pagination information
+ properties:
+ index:
+ description: Page index of results
+ format: int32
+ type: integer
+ nextPage:
+ description: Serialized pointer to the next results page. Should be used for fetching next page. Can be empty
+ type: string
+ size:
+ description: Number of results in page
+ format: int32
+ type: integer
+ totalPages:
+ description: Total number of pages available
+ format: int64
+ type: integer
+ totalResults:
+ description: Total number of results available
+ format: int64
+ type: integer
+ type: object
+ UserMetadata:
+ description: Metadata information about the user.
+ properties:
+ company:
+ description: Name of the company
+ maxLength: 128
+ type: string
+ companyUrl:
+ description: Company URL
+ type: string
+ country:
+ description: Country of the user
+ type: string
+ firstName:
+ description: User's first name
+ maxLength: 255
+ type: string
+ industry:
+ description: Industry segment
+ type: string
+ interest:
+ description: List of development areas that user has interest
+ items:
+ description: List of development areas that user has interest
+ type: string
+ type: array
+ lastName:
+ description: User's last name
+ maxLength: 255
+ type: string
+ role:
+ description: Role of the user in the company
+ type: string
+ type: object
+ UserInvitation:
+ description: User invitation to an NGC org or team
+ properties:
+ createdDate:
+ description: Date on which the invitation was created. (ISO-8601 format)
+ type: string
+ email:
+ description: Email address of the user.
+ maxLength: 128
+ minLength: 7
+ type: string
+ id:
+ description: Unique invitation ID
+ type: string
+ isProcessed:
+ description: Flag indicating if the invitation has already been accepted by the user.
+ type: boolean
+ name:
+ description: user name
+ maxLength: 64
+ minLength: 1
+ type: string
+ org:
+ description: Org to which a user was invited.
+ type: string
+ roles:
+ description: List of roles that the user have.
+ items:
+ description: List of roles that the user have.
+ type: string
+ type: array
+ team:
+ description: Team to which a user was invited.
+ type: string
+ type:
+ description: Type of invitation. The invitation is either to an organization or to a team within organization.
+ enum:
+ - ORGANIZATION
+ - TEAM
+ type: string
+ type: object
+ Team:
+ description: Information about the team
+ properties:
+ description:
+ description: description of the team
+ type: string
+ id:
+ description: unique Id of this team.
+ format: int64
+ type: integer
+ infinityManagerSettings:
+ $ref: '#/components/schemas/InfinityManagerSettings'
+ isDeleted:
+ description: indicates if the team is deleted or not
+ type: boolean
+ name:
+ description: team name
+ type: string
+ repoScanSettings:
+ $ref: '#/components/schemas/RepoScanSettings'
+ type: object
+ InfinityManagerSettings:
+ description: Infinity manager setting definition
+ properties:
+ infinityManagerEnableTeamOverride:
+ description: Allow override settings at team level. Only used in org level object
+ type: boolean
+ infinityManagerEnabled:
+ description: Enable the infinity manager or not. Used both in org and team level object
+ type: boolean
+ type: object
+ RepoScanSettings:
+ description: Repo scan setting definition
+ properties:
+ repoScanAllowOverride:
+ description: Allow org admin to override the org level repo scan settings
+ type: boolean
+ repoScanByDefault:
+ description: Allow repository scanning by default
+ type: boolean
+ repoScanEnableNotifications:
+ description: Sends notification to end user after scanning is done
+ type: boolean
+ repoScanEnableTeamOverride:
+ description: Allow override settings at team level. Only used in org level object
+ type: boolean
+ repoScanEnabled:
+ description: Enable the repository scan or not. Only used in org level object
+ type: boolean
+ repoScanShowResults:
+ description: Allow showing scan results to CLI or UI
+ type: boolean
+ type: object
+ Organization:
+ description: Information about the Organization
+ properties:
+ alternateContact:
+ $ref: '#/components/schemas/AlternateContact'
+ billingAccountId:
+ description: Billing account ID.
+ type: string
+ canAddOn:
+ description: Identifies if the org can be reused.
+ type: boolean
+ country:
+ description: ISO country code of the organization.
+ type: string
+ description:
+ description: Optional description of the organization.
+ type: string
+ displayName:
+ description: Name of the organization that will be shown to users.
+ maxLength: 255
+ minLength: 1
+ type: string
+ id:
+ description: Unique Id of this team.
+ format: int64
+ type: integer
+ idpId:
+ description: Identity Provider ID.
+ type: string
+ industry:
+ description: Industry of the organization.
+ type: string
+ infinityManagerSettings:
+ $ref: '#/components/schemas/InfinityManagerSettings'
+ isDatasetServiceEnabled:
+ description: Dataset Service enable flag for an organization
+ type: boolean
+ isInternal:
+ description: Is NVIDIA internal org or not
+ type: boolean
+ isProto:
+ description: Indicates when the org is a proto org
+ type: boolean
+ isQuickStartEnabled:
+ description: Quick Start enable flag for an organization
+ type: boolean
+ isRegistrySSEEnabled:
+ description: If a server side encryption is enabled for private registry (models, resources)
+ type: boolean
+ isSecretsManagerServiceEnabled:
+ description: Secrets Manager Service enable flag for an organization
+ type: boolean
+ isSecureCredentialSharingServiceEnabled:
+ description: Secure Credential Sharing Service enable flag for an organization
+ type: boolean
+ isSeparateInfluxDbUsed:
+ description: If a separate influx db used for an organization in BCP for job telemetry
+ type: boolean
+ name:
+ description: Organization name.
+ type: string
+ ncaAccountNumber:
+ description: NVIDIA Cloud Account Number.
+ type: string
+ orgOwner:
+ $ref: '#/components/schemas/OrgOwner'
+ orgOwners:
+ description: Org owners
+ items:
+ $ref: '#/components/schemas/OrgOwner'
+ type: array
+ pecSfdcId:
+ description: Product end customer salesforce.com Id (external customer Id). pecSfdcId is for EMS (entitlement management service) to track external paid customer.
+ type: string
+ productEnablements:
+ items:
+ $ref: '#/components/schemas/ProductEnablement'
+ type: array
+ productSubscriptions:
+ items:
+ $ref: '#/components/schemas/ProductSubscription'
+ type: array
+ repoScanSettings:
+ $ref: '#/components/schemas/RepoScanSettings'
+ type:
+ enum:
+ - UNKNOWN
+ - CLOUD
+ - ENTERPRISE
+ - INDIVIDUAL
+ type: string
+ usersInfo:
+ $ref: '#/components/schemas/UsersInfo'
+ type: object
+ OrgOwnerV3:
+ description: Org owner.
+ properties:
+ email:
+ description: Email address of the org owner.
+ maxLength: 128
+ type: string
+ fullName:
+ description: Org owner name.
+ maxLength: 64
+ minLength: 1
+ type: string
+ idpId:
+ description: Identity Provider ID of the org owner.
+ type: string
+ starfleetId:
+ description: Starfleet ID of the org owner.
+ type: string
+ required:
+ - email
+ type: object
+ ProductEnablement:
+ description: Product Enablement
+ properties:
+ expirationDate:
+ description: Date on which the subscription expires. The subscription is invalid after this date. (yyyy-MM-dd)
+ type: string
+ poDetails:
+ items:
+ $ref: '#/components/schemas/PurchaseOrder'
+ type: array
+ productName:
+ description: Product Name (NVAIE, BASE_COMMAND, REGISTRY, etc)
+ type: string
+ type:
+ description: Product Enablement Types
+ enum:
+ - NGC_ADMIN_EVAL
+ - NGC_ADMIN_NFR
+ - NGC_ADMIN_COMMERCIAL
+ - EMS_EVAL
+ - EMS_NFR
+ - EMS_COMMERCIAL
+ - NGC_ADMIN_DEVELOPER
+ type: string
+ required:
+ - productName
+ - type
+ type: object
+ ProductSubscription:
+ description: Product Subscription
+ properties:
+ emsEntitlementType:
+ description: 'EMS Subscription type. (options: EMS_EVAL, EMS_NFR and EMS_COMMERCIAL)'
+ enum:
+ - EMS_EVAL
+ - EMS_NFR
+ - EMS_COMMERICAL
+ - EMS_COMMERCIAL
+ type: string
+ expirationDate:
+ description: Date on which the subscription expires. The subscription is invalid after this date. (yyyy-MM-dd)
+ type: string
+ id:
+ description: Unique entitlement identifier
+ type: string
+ productName:
+ description: Product Name (NVAIE, BASE_COMMAND, FleetCommand, REGISTRY, etc).
+ type: string
+ startDate:
+ description: Date on which the subscription becomes active. (yyyy-MM-dd)
+ type: string
+ type:
+ description: 'Subscription type. (options: NGC_ADMIN_EVAL, NGC_ADMIN_NFR, NGC_ADMIN_COMMERCIAL)'
+ enum:
+ - NGC_ADMIN_EVAL
+ - NGC_ADMIN_NFR
+ - NGC_ADMIN_COMMERCIAL
+ type: string
+ required:
+ - productName
+ type: object
+ OrgInvitation:
+ description: Org invitation to NGC
+ properties:
+ email:
+ description: Email address of the user.
+ type: string
+ protoOrgId:
+ description: Proto Org identifier.
+ type: string
+ type: object
+ ServiceAccess:
+ description: List of actions that this role allows
+ properties:
+ accessLevels:
+ description: List of access levels that this role allows
+ items:
+ description: List of access levels that this role allows
+ type: string
+ type: array
+ service:
+ description: Service that this role allows
+ type: string
+ type: object
+ RoleProduct:
+ description: Product information of the role
+ properties:
+ displayName:
+ description: Display Name of the product from the product catalog to which this role is associated with
+ type: string
+ name:
+ description: Name of the product from the product catalog to which this role is associated with
+ type: string
+ type: object
+ UserStorageQuota:
+ description: represents user storage quota for a given ace and available unused storage
+ properties:
+ aceId:
+ description: id of the ace
+ format: int64
+ type: integer
+ aceName:
+ description: name of the ace
+ type: string
+ available:
+ description: Available space in bytes
+ format: int64
+ type: integer
+ datasetCount:
+ description: Number of datasets that are a part of user's used storage
+ format: int64
+ type: integer
+ datasetsUsage:
+ description: Space used by datasets in bytes
+ format: int64
+ type: integer
+ orgName:
+ description: The org name that this user quota tied to. This is needed for analytics
+ type: string
+ quota:
+ description: Assigned quota in bytes
+ format: int64
+ type: integer
+ resultsetCount:
+ description: Number of resultsets that are a part of user's used storage
+ format: int64
+ type: integer
+ resultsetsUsage:
+ description: Space used by resultsets in bytes
+ format: int64
+ type: integer
+ storageClusterDescription:
+ description: Description of this storage cluster
+ type: string
+ storageClusterName:
+ description: Name of storage cluster
+ type: string
+ storageClusterUuid:
+ description: Identifier to this storage cluster
+ type: string
+ workspacesCount:
+ description: Number of workspaces that are a part of user's used storage
+ format: int64
+ type: integer
+ workspacesUsage:
+ description: Space used by workspaces in bytes
+ format: int64
+ type: integer
+ type: object
+ TargetSystemUserIdentifier:
+ description: Information about the user who is attempting to run the job
+ properties:
+ gid:
+ description: gid of the user on this team
+ format: int64
+ type: integer
+ orgName:
+ description: Org context for the job
+ type: string
+ starfleetId:
+ description: Starfleet ID of the user creating the job.
+ type: string
+ teamName:
+ description: Team context for the job
+ type: string
+ uid:
+ description: uid of the user on this team
+ format: int64
+ type: integer
+ userId:
+ description: Unique ID of the user who submitted the job
+ format: int64
+ type: integer
+ type: object
+ AlternateContact:
+ description: Org Owner Alternate Contact
+ properties:
+ email:
+ description: Alternate contact's email.
+ maxLength: 128
+ minLength: 6
+ type: string
+ fullName:
+ description: Full name of the alternate contact.
+ maxLength: 255
+ type: string
+ type: object
+ OrgOwner:
+ description: Org owner.
+ properties:
+ email:
+ description: Email address of the org owner.
+ maxLength: 128
+ type: string
+ fullName:
+ description: Org owner name.
+ maxLength: 64
+ minLength: 1
+ type: string
+ lastLoginDate:
+ description: Last time the org owner logged in.
+ type: string
+ required:
+ - email
+ type: object
+ UsersInfo:
+ description: Users information.
+ properties:
+ totalUsers:
+ description: Total number of users.
+ format: int64
+ type: integer
+ type: object
+ PurchaseOrder:
+ description: Purchase Order.
+ properties:
+ entitlementId:
+ description: Entitlement identifier.
+ type: string
+ pkId:
+ description: PAK (Product Activation Key) identifier.
+ type: string
+ type: object
+ x-stackQL-resources:
+ roles:
+ id: nvidia.orgs.roles
+ name: roles
+ title: Roles
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1roles/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.roles
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/roles/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ users:
+ id: nvidia.orgs.users
+ name: users
+ title: Users
+ methods:
+ get_by_starfleet_id:
+ operation:
+ $ref: '#/paths/~1starfleetIds~1{starfleet_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.user
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1users/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.users
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1users/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ delete:
+ operation:
+ $ref: '#/paths/~1users~1{id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1users~1{user_email_or_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.user
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/users/methods/get_by_starfleet_id'
+ - $ref: '#/components/x-stackQL-resources/users/methods/get'
+ - $ref: '#/components/x-stackQL-resources/users/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/users/methods/create'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/users/methods/delete'
+ replace: []
+ team_members:
+ id: nvidia.orgs.team_members
+ name: team_members
+ title: Team Members
+ methods:
+ get_by_starfleet_id:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1starfleetIds~1{starfleet_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.users
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ add:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users~1{id}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}~1users~1{id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}~1users~1{user_email_or_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/get_by_starfleet_id'
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/get'
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/add'
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/create'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/team_members/methods/remove'
+ replace: []
+ team_invitations:
+ id: nvidia.orgs.team_invitations
+ name: team_invitations
+ title: Team Invitations
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users~1invitations/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.invitations
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ delete:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users~1invitations~1{id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ resend_email:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1users~1invitations~1{id}~1resend-invitation-email/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_nca:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}~1users~1nca-invitations/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/team_invitations/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/team_invitations/methods/create_nca'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/team_invitations/methods/delete'
+ replace: []
+ teams:
+ id: nvidia.orgs.teams
+ name: teams
+ title: Teams
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1teams/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.teams
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1teams/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.team
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/teams/methods/get'
+ - $ref: '#/components/x-stackQL-resources/teams/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/teams/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/teams/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/teams/methods/delete'
+ replace: []
+ user_invitations:
+ id: nvidia.orgs.user_invitations
+ name: user_invitations
+ title: User Invitations
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1users~1invitations/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.invitations
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ delete:
+ operation:
+ $ref: '#/paths/~1users~1invitations~1{id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ resend_email:
+ operation:
+ $ref: '#/paths/~1users~1invitations~1{id}~1resend-invitation-email/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_nca:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1users~1nca-invitations/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/user_invitations/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/user_invitations/methods/create_nca'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/user_invitations/methods/delete'
+ replace: []
+ orgs:
+ id: nvidia.orgs.orgs
+ name: orgs
+ title: Orgs
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1v2~1orgs/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.organizations
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1orgs~1{org_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.organizations
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1orgs~1{org_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v3~1orgs/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/orgs/methods/get'
+ - $ref: '#/components/x-stackQL-resources/orgs/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/orgs/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/orgs/methods/update'
+ delete: []
+ replace: []
+ current_user:
+ id: nvidia.orgs.current_user
+ name: current_user
+ title: Current User
+ methods:
+ get:
+ operation:
+ $ref: '#/paths/~1v2~1users~1me/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.user
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v2~1users~1me/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create_api_key:
+ operation:
+ $ref: '#/paths/~1v2~1users~1me~1api-key/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/current_user/methods/get'
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/current_user/methods/update'
+ delete: []
+ replace: []
+ proto_orgs:
+ id: nvidia.orgs.proto_orgs
+ name: proto_orgs
+ title: Proto Orgs
+ methods:
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1v3~1orgs~1proto-org/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ validate:
+ operation:
+ $ref: '#/paths/~1v3~1orgs~1proto-org~1validate/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.orgInvitation
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/proto_orgs/methods/validate'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/proto_orgs/methods/create'
+ update: []
+ delete: []
+ replace: []
+ team_member_roles:
+ id: nvidia.orgs.team_member_roles
+ name: team_member_roles
+ title: Team Member Roles
+ methods:
+ add:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}~1users~1{user_email_or_id}~1add-role/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ operation:
+ $ref: '#/paths/~1teams~1{team_name}~1users~1{user_email_or_id}~1remove-role/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/team_member_roles/methods/add'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/team_member_roles/methods/remove'
+ replace: []
+ user_roles:
+ id: nvidia.orgs.user_roles
+ name: user_roles
+ title: User Roles
+ methods:
+ add:
+ operation:
+ $ref: '#/paths/~1users~1{user_email_or_id}~1add-role/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ operation:
+ $ref: '#/paths/~1users~1{user_email_or_id}~1remove-role/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/user_roles/methods/add'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/user_roles/methods/remove'
+ replace: []
+servers:
+ - url: https://api.ngc.nvidia.com
diff --git a/providers/src/nvidia/v00.00.00000/services/private_registry.yaml b/providers/src/nvidia/v00.00.00000/services/private_registry.yaml
new file mode 100644
index 00000000..cdd36ddf
--- /dev/null
+++ b/providers/src/nvidia/v00.00.00000/services/private_registry.yaml
@@ -0,0 +1,20458 @@
+openapi: 3.1.0
+info:
+ title: NVIDIA NGC Private Registry
+ description: 'Org-scoped artifact metadata in the NGC private registry: models, resources, recipes, generic artifacts (helm charts, endpoints, blueprints, agents, playbooks, APIs, skills), versions and files, collections, shares, deployment parameters, encryption keys and workflows. Team-scoped twins are mapped as *_by_team methods (source: the Private Artifacts (Models) API definition, responses from the ngcsdk data classes).'
+ version: 0.0.1-SNAPSHOT
+paths:
+ /encryption-keys:
+ get:
+ description: List encryption keys in org
+ operationId: listKeysInOrg
+ parameters: []
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KeyListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List encryption keys in org
+ tags:
+ - Encryption Keys
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /encryption-keys/{key_id}:
+ get:
+ description: List artifacts for encryption key in org
+ operationId: listArtifactsForKeyInOrg
+ parameters:
+ - description: Key ID
+ in: path
+ name: key_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: query
+ name: artifact-type
+ required: false
+ schema:
+ default: MODEL
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KeyArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifacts for encryption key in org
+ tags:
+ - Encryption Keys
+ delete:
+ description: Revoke encryption key and disassociate from all artifacts in org
+ operationId: deleteKeyFromOrg
+ parameters:
+ - description: Key ID
+ in: path
+ name: key_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusUrlResponse'
+ description: Accepted
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Revoke encryption key in org
+ tags:
+ - Encryption Keys
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/encryption-keys:
+ get:
+ description: List encryption keys in org/team
+ operationId: listKeysInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KeyListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List encryption keys in org/team
+ tags:
+ - Encryption Keys
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/encryption-keys/{key_id}:
+ get:
+ description: List artifacts for encryption key in org/team
+ operationId: listArtifactsForKeyInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Key ID
+ in: path
+ name: key_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: query
+ name: artifactType
+ required: false
+ schema:
+ default: MODEL
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/KeyArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifacts for encryption key in org/team
+ tags:
+ - Encryption Keys
+ delete:
+ description: Revoke encryption key and disassociate from all artifacts in org/team
+ operationId: deleteKeyFromTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Key ID
+ in: path
+ name: key_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusUrlResponse'
+ description: Accepted
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Revoke encryption key in org/team
+ tags:
+ - Encryption Keys
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team}/workflows/{workflow_id}:
+ get:
+ description: Returns the current status (pending, running, completed, or failed) of an artifact-registry Temporal workflow execution within the specified organization and team.
+ operationId: getWorkflowStatusForTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Workflow identifier
+ in: path
+ name: workflow_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get team-scoped workflow status
+ tags:
+ - Workflows
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /workflows/{workflow_id}:
+ get:
+ description: Returns the current status (pending, running, completed, or failed) of an artifact-registry Temporal workflow execution within the specified organization.
+ operationId: getWorkflowStatus
+ parameters:
+ - description: Workflow identifier
+ in: path
+ name: workflow_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get workflow status
+ tags:
+ - Workflows
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/artifact-registry/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections:
+ get:
+ description: List collections the user can access in the specified org
+ operationId: listCollectionsInOrg
+ parameters:
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collections in org
+ tags:
+ - Collections
+ post:
+ description: Create collection in org
+ operationId: createCollectionInOrg
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create collection in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}:
+ get:
+ description: Get collection details in org
+ operationId: getCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get collection in org
+ tags:
+ - Collections
+ patch:
+ description: Update collection details in org
+ operationId: updateCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update collection in org
+ tags:
+ - Collections
+ delete:
+ description: Delete collection in the specified org
+ operationId: deleteCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete collection in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/artifacts:
+ patch:
+ description: Patch collection in the specified org
+ operationId: patchCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionPatchRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Patch collection in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/artifacts/org/{artifact_org_name}/team/{artifact_team_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org from another org and team
+ operationId: addArtifactToCollectionInOrgFromAnotherOrgAndTeam
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact team name
+ in: path
+ name: artifact_team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org from another org and team
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org from another org
+ operationId: removeArtifactFromCollectionInOrgFromAnotherOrgAndTeam
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact team name
+ in: path
+ name: artifact_team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org from another org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/artifacts/org/{artifact_org_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org from another org
+ operationId: addArtifactToCollectionInOrgFromAnotherOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org from another org
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org from another org
+ operationId: removeArtifactFromCollectionInOrgFromAnotherOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org from another org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/artifacts/{artifact_type}:
+ get:
+ description: List collection artifacts the user can access in the specified org
+ operationId: listCollectionArtifactsInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collection artifacts in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/share/product:
+ put:
+ description: Publish collection to product
+ operationId: publishCollectionFromRequest
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish collection to product
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /collections/{collection_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org
+ operationId: addArtifactToCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org
+ operationId: removeArtifactFromCollectionInOrg
+ parameters:
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /helm-charts/{artifact_name}/versions:
+ get:
+ description: List chart versions in org
+ operationId: listHelmChartVersionsInOrg
+ parameters:
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List chart versions in org
+ tags:
+ - Helm Charts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /helm-charts/{artifact_name}/versions/{version_id}:
+ get:
+ description: Get chart version in org
+ operationId: getHelmChartVersionInOrg
+ parameters:
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get chart version in org
+ tags:
+ - Helm Charts
+ patch:
+ description: Update chart version information in org e.g. upload status
+ operationId: updateHelmChartVersionInOrg
+ parameters:
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update chart version in org
+ tags:
+ - Helm Charts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models:
+ get:
+ description: This operation lists models the user can access in the org.
+ operationId: listModelsInOrg
+ parameters:
+ - deprecated: true
+ description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - deprecated: true
+ description: '[Deprecated] Page reference, Use page-number instead'
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List models in org
+ tags:
+ - Models
+ post:
+ description: This operation creates a model in the org.
+ operationId: createModelInOrg
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create model in org
+ tags:
+ - Models
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{artifact_name}/versions/{version_id}/stash:
+ patch:
+ description: Stash artifact version information in org during upload paused state
+ operationId: stashArtifactVersionInOrg
+ parameters:
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Stash artifact version in org
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{model_name}:
+ get:
+ description: This operation gets info of a model in the org.
+ operationId: getModelInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model details in org
+ tags:
+ - Models
+ patch:
+ description: This operation updates details of a model in the org.
+ operationId: updateModelInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update model in org
+ tags:
+ - Models
+ delete:
+ tags:
+ - Models
+ summary: Delete model in org
+ description: 'This operation deletes a model in the org (SDK evidence: ngcsdk registry/api/models.py remove_model; not declared in the published definition).'
+ operationId: deleteModelInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ x-stackql-sdk-evidence: ngcsdk registry/api
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{model_name}/encryption-key:
+ delete:
+ description: Disassociate encryption key from model in org and mark it for offline deletion
+ operationId: disassociateKeyFromModelInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusUrlResponse'
+ description: Accepted
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Disassociate encryption key from model in org
+ tags:
+ - Models
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{model_name}/versions:
+ get:
+ description: List model versions in org
+ operationId: listModelVersionsInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model versions in org
+ tags:
+ - Model Version
+ post:
+ description: Create a new and empty model version in org. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createModelVersionInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create model version in org
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{model_name}/versions/{version_id}:
+ get:
+ description: Get model version in org
+ operationId: getModelVersionInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model version in org
+ tags:
+ - Model Version
+ patch:
+ description: Update model version information in org e.g. upload status
+ operationId: updateModelVersionInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update model version in org
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /models/{model_name}/versions/{version_id}/files:
+ get:
+ description: List files of the model version in org
+ operationId: listModeFilesInOrg
+ parameters:
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model files in org
+ tags:
+ - Model Version Files
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /recipes:
+ get:
+ description: List recipes the user can access in the specified org
+ operationId: listRecipesInOrg
+ parameters:
+ - description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipes in org
+ tags:
+ - Resources
+ post:
+ description: Create recipe in org
+ operationId: createRecipeInOrg
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe in org
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /recipes/{recipe_name}:
+ get:
+ description: Get recipe in org
+ operationId: getRecipeInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in org
+ tags:
+ - Resources
+ patch:
+ description: Update recipe details in org
+ operationId: updateRecipeInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe in org
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /recipes/{recipe_name}/versions:
+ get:
+ description: List recipe versions in org
+ operationId: listRecipeVersionsInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in org
+ tags:
+ - Resource Versions
+ post:
+ description: Create recipe version in org. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createRecipeVersionInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe version in org
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /recipes/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in org
+ operationId: getRecipeVersionInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in org
+ tags:
+ - Resource Versions
+ patch:
+ description: Update recipe version information in org e.g. upload status
+ operationId: updateRecipeVersionInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe version in org
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /recipes/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List recipe files in org
+ operationId: listRecipeFilesInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in org
+ tags:
+ - Resource Version Files endpoints
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /repositories/{container_name}/associated-models:
+ get:
+ description: List associated model versions by container
+ operationId: listModelVersionsAssociatedByContainer
+ parameters:
+ - description: Container name
+ in: path
+ name: container_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List associated model versions by container
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /repositories/{container_name}/tags/{container_tag}/associated-models:
+ get:
+ description: List associated model versions by container
+ operationId: listModelVersionsAssociatedByContainer_2
+ parameters:
+ - description: Container name
+ in: path
+ name: container_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Container tag
+ in: path
+ name: container_tag
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List associated model versions by container
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /resources:
+ get:
+ description: List recipes the user can access in the specified org
+ operationId: listRecipesInOrg_1
+ parameters:
+ - description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipes in org
+ tags:
+ - Resources
+ post:
+ description: Create recipe in org
+ operationId: createRecipeInOrg_1
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe in org
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /resources/{recipe_name}:
+ get:
+ description: Get recipe in org
+ operationId: getRecipeInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in org
+ tags:
+ - Resources
+ patch:
+ description: Update recipe details in org
+ operationId: updateRecipeInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe in org
+ tags:
+ - Resources
+ delete:
+ tags:
+ - Resources
+ summary: Delete resource in org
+ description: 'This operation deletes a resource in the org (SDK evidence: ngcsdk registry/api/resources.py remove; not declared in the published definition).'
+ operationId: deleteResourceInOrg
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ x-stackql-sdk-evidence: ngcsdk registry/api
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /resources/{recipe_name}/versions:
+ get:
+ description: List recipe versions in org
+ operationId: listRecipeVersionsInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in org
+ tags:
+ - Resource Versions
+ post:
+ description: Create recipe version in org. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createRecipeVersionInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe version in org
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /resources/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in org
+ operationId: getRecipeVersionInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in org
+ tags:
+ - Resource Versions
+ patch:
+ description: Update recipe version information in org e.g. upload status
+ operationId: updateRecipeVersionInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe version in org
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /resources/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List recipe files in org
+ operationId: listRecipeFilesInOrg_1
+ parameters:
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in org
+ tags:
+ - Resource Version Files endpoints
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections:
+ get:
+ description: List collections the user can access in the specified org and team
+ operationId: listCollectionsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collections in team
+ tags:
+ - Collections
+ post:
+ description: Create collection in org and team
+ operationId: createCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create collection in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}:
+ get:
+ description: Get collection details in team
+ operationId: getCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get collection in team
+ tags:
+ - Collections
+ patch:
+ description: Update collection details in team
+ operationId: updateCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update collection in team
+ tags:
+ - Collections
+ delete:
+ description: Delete collection in the specified org and team
+ operationId: deleteCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete collection in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/artifacts:
+ patch:
+ description: Patch collection in the specified org and team
+ operationId: patchCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionPatchRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Patch collection in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/artifacts/org/{artifact_org_name}/team/{artifact_team_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org and team from another org and team
+ operationId: addArtifactToCollectionInTeamFromAnotherOrgAndTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact team name
+ in: path
+ name: artifact_team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org and team from another org and team
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org and team from another org and team
+ operationId: removeArtifactFromCollectionInTeamFromAnotherOrgAndTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact team name
+ in: path
+ name: artifact_team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org and team from another org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/artifacts/org/{artifact_org_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org and team from another org
+ operationId: addArtifactToCollectionInTeamFromAnotherOrg
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org and team from another org
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org and team from another org
+ operationId: removeArtifactFromCollectionInTeamFromAnotherOrg
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact organization name
+ in: path
+ name: artifact_org_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org and team from another org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/artifacts/{artifact_type}:
+ get:
+ description: List collection artifacts the user can access in the specified org and team
+ operationId: listCollectionArtifactsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List collection artifacts in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/share/product:
+ put:
+ description: Publish collection to product
+ operationId: publishCollectionFromRequest_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish collection to product
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/collections/{collection_name}/{artifact_type}/{artifact_name}:
+ put:
+ description: Add artifact to the specified collection in the specified org and team
+ operationId: addArtifactToCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Add artifact to collection in org and team
+ tags:
+ - Collections
+ delete:
+ description: Remove artifact from the specified collection in the specified org and team
+ operationId: removeArtifactFromCollectionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Collection name
+ in: path
+ name: collection_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Remove artifact from collection in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/helm-charts/{artifact_name}/versions:
+ get:
+ description: List chart versions in team
+ operationId: listHelmChartVersionsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List chart versions in team
+ tags:
+ - Helm Charts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/helm-charts/{artifact_name}/versions/{version_id}:
+ get:
+ description: Get chart version in team
+ operationId: getHelmChartVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get chart version in team
+ tags:
+ - Helm Charts
+ patch:
+ description: Update chart version information in team e.g. upload status
+ operationId: updateHelmChartVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update chart version in team
+ tags:
+ - Helm Charts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models:
+ get:
+ description: This operation lists models the user can access in the org/team.
+ operationId: listModelsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - deprecated: true
+ description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - deprecated: true
+ description: '[Deprecated] Page reference, Use page-number instead'
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List models in team
+ tags:
+ - Models
+ post:
+ description: This operation creates a model in the org/team.
+ operationId: createModelInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create model in team
+ tags:
+ - Models
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{artifact_name}/versions/{version_id}/stash:
+ patch:
+ description: Stash artifact version information in team in model version upload paused state
+ operationId: stashArtifactVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Stash artifact version in team
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{model_name}:
+ get:
+ description: This operation gets info of a model in the org/team.
+ operationId: getModelInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model in team
+ tags:
+ - Models
+ patch:
+ description: This operation updates details of a model in the org/team.
+ operationId: updateModelInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update model in team
+ tags:
+ - Models
+ delete:
+ tags:
+ - Models
+ summary: Delete model in org/team
+ description: 'This operation deletes a model in the org/team (SDK evidence: ngcsdk registry/api/models.py remove_model; not declared in the published definition).'
+ operationId: deleteModelInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ x-stackql-sdk-evidence: ngcsdk registry/api
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{model_name}/encryption-key:
+ delete:
+ description: Disassociate encryption key from model in team and mark it for offline deletion
+ operationId: disassociateKeyFromModelInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ responses:
+ '202':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/WorkflowStatusUrlResponse'
+ description: Accepted
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Disassociate encryption key from model in team
+ tags:
+ - Models
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{model_name}/versions:
+ get:
+ description: List model versions in team
+ operationId: listModelVersionsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model versions in team
+ tags:
+ - Model Version
+ post:
+ description: Create model version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createModelVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create model version in team.
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{model_name}/versions/{version_id}:
+ get:
+ description: Get model version in team
+ operationId: getModelVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get model version in team
+ tags:
+ - Model Version
+ patch:
+ description: Update model version information in team e.g. upload status
+ operationId: updateModelVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update model version in team
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/models/{model_name}/versions/{version_id}/files:
+ get:
+ description: List files of the model version in team
+ operationId: listModeFilesInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: model_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List model files in team
+ tags:
+ - Model Version Files
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/recipes:
+ get:
+ description: List recipes the user can access in the specified org and team
+ operationId: listRecipesInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipes in team
+ tags:
+ - Resources
+ post:
+ description: Create recipe in team
+ operationId: createRecipeInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe in team
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/recipes/{recipe_name}:
+ get:
+ description: Get recipe details in team
+ operationId: getRecipeInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in team
+ tags:
+ - Resources
+ patch:
+ description: Update recipe details in team
+ operationId: updateRecipeInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe in team
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/recipes/{recipe_name}/versions:
+ get:
+ description: List recipe versions in team
+ operationId: listRecipeVersionsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in team
+ tags:
+ - Resource Versions
+ post:
+ description: Create recipe version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createRecipeVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe version in team
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/recipes/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in team
+ operationId: getRecipeVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in team
+ tags:
+ - Resource Versions
+ patch:
+ description: Update recipe version information in team e.g. upload status
+ operationId: updateRecipeVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe version in team
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/recipes/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List recipe files in team
+ operationId: listRecipeFilesInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in team
+ tags:
+ - Resource Version Files endpoints
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/repositories/{container_name}/associated-models:
+ get:
+ description: List associated model versions by container
+ operationId: listModelVersionsAssociatedByContainer_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Container name
+ in: path
+ name: container_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List associated model versions by container
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/repositories/{container_name}/tags/{container_tag}/associated-models:
+ get:
+ description: List associated model versions by container
+ operationId: listModelVersionsAssociatedByContainer_3
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Container name
+ in: path
+ name: container_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Container tag
+ in: path
+ name: container_tag
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 1000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ModelVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List associated model versions by container
+ tags:
+ - Model Version
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/resources:
+ get:
+ description: List recipes the user can access in the specified org and team
+ operationId: listRecipesInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Application name
+ in: query
+ name: app-name
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipes in team
+ tags:
+ - Resources
+ post:
+ description: Create recipe in team
+ operationId: createRecipeInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe in team
+ tags:
+ - Resources
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/resources/{recipe_name}:
+ get:
+ description: Get recipe details in team
+ operationId: getRecipeInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe in team
+ tags:
+ - Resources
+ patch:
+ description: Update recipe details in team
+ operationId: updateRecipeInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe in team
+ tags:
+ - Resources
+ delete:
+ tags:
+ - Resources
+ summary: Delete resource in org/team
+ description: 'This operation deletes a resource in the org/team (SDK evidence: ngcsdk registry/api/resources.py remove; not declared in the published definition).'
+ operationId: deleteResourceInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ x-stackql-sdk-evidence: ngcsdk registry/api
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/resources/{recipe_name}/versions:
+ get:
+ description: List recipe versions in team
+ operationId: listRecipeVersionsInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Sort order
+ in: query
+ name: sort-order
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Release Type
+ in: query
+ name: release-type
+ required: false
+ schema:
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe versions in team
+ tags:
+ - Resource Versions
+ post:
+ description: Create recipe version in team. Please use the string versionId and not the deprecated numeric id. Semantic Versioning is recommended https://semver.org
+ operationId: createRecipeVersionInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create recipe version in team
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/resources/{recipe_name}/versions/{version_id}:
+ get:
+ description: Get recipe version in team
+ operationId: getRecipeVersionInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get recipe version in team
+ tags:
+ - Resource Versions
+ patch:
+ description: Update recipe version information in team e.g. upload status
+ operationId: updateRecipeVersionInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Create zip of version content
+ in: query
+ name: create-zip
+ required: false
+ schema:
+ type: boolean
+ - description: Set version to latest
+ in: query
+ name: set-latest
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update recipe version in team
+ tags:
+ - Resource Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/resources/{recipe_name}/versions/{version_id}/files:
+ get:
+ description: List recipe files in team
+ operationId: listRecipeFilesInTeam_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Recipe name
+ in: path
+ name: recipe_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page reference
+ in: query
+ name: page-reference
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 1024
+ minLength: 0
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RecipeVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List recipe files in team
+ tags:
+ - Resource Version Files endpoints
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}:
+ get:
+ description: List artifacts the user can access in the specified org and team
+ operationId: listArtifactsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifacts in team
+ tags:
+ - Artifacts
+ post:
+ description: Create artifact in team
+ operationId: createArtifactInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact in team
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}:
+ get:
+ description: Get artifact details in team
+ operationId: getArtifactInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact in team
+ tags:
+ - Artifacts
+ put:
+ description: Replace artifact details in team
+ operationId: replaceArtifactInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Replace artifact in team
+ tags:
+ - Artifacts
+ patch:
+ description: Update artifact details in team
+ operationId: updateArtifactInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact in team
+ tags:
+ - Artifacts
+ delete:
+ description: Delete artifact in team
+ operationId: deleteArtifactInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete artifact in team
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/catalog/flags:
+ get:
+ description: Get the Catalog Public flags for artifact in team
+ operationId: getPublicFlagsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactCatalogFlags'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get Catalog flags
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/collections:
+ get:
+ description: List artifact collections the user can access in the specified org and team
+ operationId: listArtifactCollectionsInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact collections in org and team
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/collections/sync-release-type-labels:
+ post:
+ description: Sync release type labels for all collections containing this artifact. Internal API for service-to-service communication.
+ operationId: syncCollectionReleaseTypeLabelsForArtifact_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Sync collection release type labels for artifact
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/deployments/params:
+ get:
+ description: List artifact deployment parameters in team
+ operationId: listArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact deployment parameters in team
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/deployments/{csp_name}/params:
+ get:
+ description: Get artifact deployment parameters details in team
+ operationId: getArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact deployment parameters details in team
+ tags:
+ - Artifact deployment parameters
+ post:
+ description: Create artifact deployment parameters in team
+ operationId: createArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: No auto labels
+ in: query
+ name: no-auto-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Merge CSP parameters in response
+ in: query
+ name: merge-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact deployment parameters in team
+ tags:
+ - Artifact deployment parameters
+ patch:
+ description: Update artifact deployment parameters in team
+ operationId: updateArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Merge CSP parameters in response
+ in: query
+ name: merge-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact deployment parameters in team
+ tags:
+ - Artifact deployment parameters
+ delete:
+ description: Delete artifact deployment parameters in team
+ operationId: deleteArtifactDeploymentParametersInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete artifact deployment parameters in team
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/license/acceptance:
+ post:
+ description: Record license acceptance for an org artifact.
+ operationId: acceptArtifactLicense_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AcceptArtifactLicenseRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Accept artifact license
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/release-type:
+ put:
+ description: Updates the release type (for example GA, EA, beta) of an artifact version within the specified organization and optional team.
+ operationId: updateReleaseLabel_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateReleaseTypeRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact version release type
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/share:
+ put:
+ description: Publish artifact to public
+ operationId: publishArtifact_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Indicates if guest users can download this artifact
+ in: query
+ name: guest-can-download
+ required: true
+ schema:
+ type: boolean
+ - description: Indicates if artifact is listed publicly
+ in: query
+ name: public-can-list
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact to public
+ tags:
+ - Publish
+ delete:
+ description: Undo publishing of artifact to public
+ operationId: undoPublishArtifact_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Undo publishing of artifact to public
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/share/product:
+ put:
+ description: Publish artifact to product
+ operationId: publishArtifactFromRequest_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact to product
+ tags:
+ - Publish
+ delete:
+ description: Undo publishing of product artifacts
+ operationId: undoPublishProduct_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Undo publishing of product artifacts
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/terms-of-service:
+ put:
+ description: Update artifact terms of service
+ operationId: updateTermsOfService_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact terms of service
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}:
+ delete:
+ description: Delete a artifact version in team
+ operationId: deleteArtifactVersionInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete a artifact version in team
+ tags:
+ - Artifact Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}/configs:
+ patch:
+ description: Update artifact version with configs like policy badge
+ operationId: updateTagLevelPublishConfigs_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateArtifactVersionConfigs'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact version with configs like policy badge
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}/deployments/{csp_name}:
+ post:
+ description: Create artifact version deployment url in team
+ operationId: createArtifactDeploymentUrlInTeam
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentUrlCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentUrlResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact version deployment url in team
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}/files:
+ get:
+ description: List files of the artifact version in team
+ operationId: listArtifactFilesInTeam
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact files in team
+ tags:
+ - Artifact Version Files
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}/signature:
+ put:
+ description: Request to sign artifact version
+ operationId: signArtifactVersion_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactDownloadResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ tags:
+ - ArtifactSigning
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}:
+ get:
+ description: List artifacts the user can access in the specified org
+ operationId: listArtifactsInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifacts in org
+ tags:
+ - Artifacts
+ post:
+ description: Create artifact in org
+ operationId: createArtifactInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact in org
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}:
+ get:
+ description: Get artifact details in org
+ operationId: getArtifactInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact in org
+ tags:
+ - Artifacts
+ put:
+ description: Replace artifact details in org
+ operationId: replaceArtifactInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Replace artifact in org
+ tags:
+ - Artifacts
+ patch:
+ description: Update artifact details in org
+ operationId: updateArtifactInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact in org
+ tags:
+ - Artifacts
+ delete:
+ description: Delete artifact in org
+ operationId: deleteArtifactInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete artifact in org
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/catalog/flags:
+ get:
+ description: Get the Catalog Public flags for artifact in org
+ operationId: getPublicFlagsInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactCatalogFlags'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get Catalog flags
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/collections:
+ get:
+ description: List artifact collections the user can access in the specified org
+ operationId: listArtifactCollectionsInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ - description: Order by
+ in: query
+ name: order-by
+ required: false
+ schema:
+ enum:
+ - ALPHABETIC_ASC
+ - ALPHABETIC_DESC
+ - CREATED_DATE_ASC
+ - CREATED_DATE_DESC
+ - SEMVER_ASC
+ - SEMVER_DESC
+ - DISPLAY_NAME_ASC
+ - DISPLAY_NAME_DESC
+ - UPDATED_DATE_ASC
+ - UPDATED_DATE_DESC
+ - PUBLISHER_ASC
+ - PUBLISHER_DESC
+ - BUILT_BY_ASC
+ - BUILT_BY_DESC
+ - RESOURCE_ID_ASC
+ - RESOURCE_ID_DESC
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Resolve labels
+ in: query
+ name: resolve-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Remove unresolved labels
+ in: query
+ name: remove-unresolved-labels
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CollectionListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact collections in org
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/collections/sync-release-type-labels:
+ post:
+ description: Sync release type labels for all collections containing this artifact. Internal API for service-to-service communication.
+ operationId: syncCollectionReleaseTypeLabelsForArtifact
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Sync collection release type labels for artifact
+ tags:
+ - Collections
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/deployments/params:
+ get:
+ description: List artifact deployment parameters in org
+ operationId: listArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact deployment parameters in org
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/deployments/{csp_name}/params:
+ get:
+ description: Get artifact deployment parameters details in org
+ operationId: getArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Inherit CSP parameters
+ in: query
+ name: inherit-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get artifact deployment parameters details in org
+ tags:
+ - Artifact deployment parameters
+ post:
+ description: Create artifact deployment parameters in org
+ operationId: createArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: No auto labels
+ in: query
+ name: no-auto-labels
+ required: false
+ schema:
+ type: boolean
+ - description: Merge CSP parameters in response
+ in: query
+ name: merge-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact deployment parameters in org
+ tags:
+ - Artifact deployment parameters
+ patch:
+ description: Update artifact deployment parameters in org
+ operationId: updateArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Merge CSP parameters in response
+ in: query
+ name: merge-csp-parameters
+ required: false
+ schema:
+ type: boolean
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParametersUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact deployment parameters in org
+ tags:
+ - Artifact deployment parameters
+ delete:
+ description: Delete artifact deployment parameters in org
+ operationId: deleteArtifactDeploymentParametersInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete artifact deployment parameters in org
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/license/acceptance:
+ post:
+ description: Record license acceptance for an org artifact.
+ operationId: acceptArtifactLicense
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AcceptArtifactLicenseRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Accept artifact license
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/release-type:
+ put:
+ description: Updates the release type (for example GA, EA, beta) of an artifact version within the specified organization and optional team.
+ operationId: updateReleaseLabel
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateReleaseTypeRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact version release type
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/share:
+ put:
+ description: Publish artifact to public
+ operationId: publishArtifact
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Indicates if guest users can download this artifact
+ in: query
+ name: guest-can-download
+ required: true
+ schema:
+ type: boolean
+ - description: Indicates if artifact is listed publicly
+ in: query
+ name: public-can-list
+ required: false
+ schema:
+ type: boolean
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact to public
+ tags:
+ - Publish
+ delete:
+ description: Undo publishing of artifact to public
+ operationId: undoPublishArtifact
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Undo publishing of artifact to public
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/share/product:
+ put:
+ description: Publish artifact to product
+ operationId: publishArtifactFromRequest
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact to product
+ tags:
+ - Publish
+ delete:
+ description: Undo publishing of product artifacts
+ operationId: undoPublishProduct
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Undo publishing of product artifacts
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/terms-of-service:
+ put:
+ description: Update artifact terms of service
+ operationId: updateTermsOfService
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactPublishRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update artifact terms of service
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}:
+ delete:
+ description: Delete a artifact version in org
+ operationId: deleteArtifactVersionInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete a artifact version in org
+ tags:
+ - Artifact Versions
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}/configs:
+ patch:
+ description: Update artifact version with configs like policy badge
+ operationId: updateTagLevelPublishConfigs
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/UpdateArtifactVersionConfigs'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Publish artifact version with configs like policy badge
+ tags:
+ - Publish
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}/deployments/{csp_name}:
+ post:
+ description: Create artifact version deployment url in org
+ operationId: createArtifactDeploymentUrlInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - repositories
+ - recipes
+ - models
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Cloud service provider name
+ in: path
+ name: csp_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentUrlCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/DeploymentUrlResponse'
+ description: OK
+ '400':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Bad Request
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '409':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Conflict
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create artifact version deployment url in org
+ tags:
+ - Artifact deployment parameters
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}/files:
+ get:
+ description: List files of the artifact version in org
+ operationId: listArtifactFilesInOrg
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Page size
+ in: query
+ name: page-size
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 5000
+ minLength: 0
+ minimum: 1
+ type: string
+ - description: Page number - zero based index
+ in: query
+ name: page-number
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ maximum: 10000
+ minLength: 0
+ minimum: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactVersionFileListResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: List artifact files in org
+ tags:
+ - Artifact Version Files
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}/signature:
+ put:
+ description: Request to sign artifact version
+ operationId: signArtifactVersion
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ArtifactDownloadResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ tags:
+ - ArtifactSigning
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/versions/{version_id}/malware-scan:
+ post:
+ description: Initiates malwares can for the artifact
+ operationId: initiateMalwareScan_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ - description: Contact email
+ in: query
+ name: contact-email
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 320
+ minLength: 0
+ type: string
+ - description: Nspect identifier
+ in: query
+ name: nspect-id
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 64
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Initiates malwares can for the artifact
+ tags:
+ - MalwareScan
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/spec:
+ post:
+ description: Create AI Playground for artifactType
+ operationId: createModelArtifactsSpec_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create AI Playground for artifactType
+ tags:
+ - AIPlayground
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/purge:
+ delete:
+ description: Purge Search DB for deleted artifacts
+ operationId: purgeDeletedArtifact_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Purge Search DB
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /team/{team_name}/{artifact_type}/{artifact_name}/spec:
+ get:
+ description: Get AI Playground for artifactType
+ operationId: getModelArtifactsSpec_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get AI Playground for artifactType
+ tags:
+ - AIPlayground
+ put:
+ description: Update AI Playground for artifactType
+ operationId: updateModelArtifactsSpec_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update AI Playground for artifactType
+ tags:
+ - AIPlayground
+ delete:
+ description: Delete AI Playground for artifactType
+ operationId: deleteModelArtifactsSpec_1
+ parameters:
+ - description: Team name
+ in: path
+ name: team_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete AI Playground for artifactType
+ tags:
+ - AIPlayground
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/versions/{version_id}/malware-scan:
+ post:
+ description: Initiates malwares can for the artifact
+ operationId: initiateMalwareScan
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 255
+ minLength: 0
+ type: string
+ - description: Version ID
+ in: path
+ name: version_id
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 512
+ minLength: 0
+ type: string
+ - description: Contact email
+ in: query
+ name: contact-email
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 320
+ minLength: 0
+ type: string
+ - description: Nspect identifier
+ in: query
+ name: nspect-id
+ required: false
+ schema:
+ format: UTF-8
+ maxLength: 64
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Initiates malwares can for the artifact
+ tags:
+ - MalwareScan
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/spec:
+ post:
+ description: Create AI Playground for artifactType
+ operationId: createModelArtifactsSpec
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundCreateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Create AI Playground for artifactType
+ tags:
+ - AIPlayground
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/purge:
+ delete:
+ description: Purge Search DB for deleted artifacts
+ operationId: purgeDeletedArtifact
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Artifact name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Purge Search DB
+ tags:
+ - Artifacts
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+ /{artifact_type}/{artifact_name}/spec:
+ get:
+ description: Get AI Playground for artifactType
+ operationId: getModelArtifactsSpec
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Get AI Playground for artifactType
+ tags:
+ - AIPlayground
+ put:
+ description: Update AI Playground for artifactType
+ operationId: updateModelArtifactsSpec
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundUpdateRequest'
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AIPlaygroundResponse'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Update AI Playground for artifactType
+ tags:
+ - AIPlayground
+ delete:
+ description: Delete AI Playground for artifactType
+ operationId: deleteModelArtifactsSpec
+ parameters:
+ - description: Artifact type
+ in: path
+ name: artifact_type
+ required: true
+ schema:
+ enum:
+ - models
+ - helm-charts
+ - endpoints
+ - agents
+ - blueprints
+ - apis
+ - playbooks
+ - skills
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ - description: Model name
+ in: path
+ name: artifact_name
+ required: true
+ schema:
+ format: UTF-8
+ maxLength: 262144
+ minLength: 0
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: OK
+ '401':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Unauthorized
+ '403':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Forbidden
+ '404':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Not Found
+ '429':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Too many requests
+ '500':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Response'
+ description: Internal Error
+ summary: Delete AI Playground for artifactType
+ tags:
+ - AIPlayground
+ servers:
+ - url: https://api.ngc.nvidia.com/v2/org/{org_name}
+ variables:
+ org_name:
+ description: NGC organization name (the org id shown in the NGC console under Organization -> Setup, e.g. 0123456789ab). Resolved from the NGC_ORG environment variable when it is set (x-stackQL-envVar - the same variable the NVIDIA Terraform provider reads); otherwise it must be supplied on every org-scoped query as WHERE org_name = ''. A WHERE value always takes precedence over the environment.
+ x-stackQL-envVar: NGC_ORG
+components:
+ schemas:
+ KeyListResponse:
+ description: Response to list keys request
+ properties:
+ encryptionKeys:
+ items:
+ $ref: '#/components/schemas/KeyItem'
+ type: array
+ type: object
+ Response:
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ WorkflowStatusUrlResponse:
+ description: Response containing workflow status URL and ID
+ properties:
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ statusUrl:
+ description: URL to check the workflow status
+ type: string
+ workflowId:
+ description: ID of the workflow
+ type: string
+ type: object
+ KeyArtifactListResponse:
+ description: Response containing a list of artifacts associated with a key
+ properties:
+ artifacts:
+ items:
+ $ref: '#/components/schemas/ArtifactItem'
+ type: array
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ WorkflowStatusResponse:
+ description: Response containing workflow status information
+ properties:
+ cloneStatus:
+ $ref: '#/components/schemas/CloneStatus'
+ description: Progress of cloning artifact version files
+ duration:
+ description: Wall-clock execution duration as an ISO-8601 duration (e.g. PT1H30M5S, PT0.001S); Omitted while IN_PROGRESS.
+ type: string
+ endTime:
+ description: UTC instant when the workflow reached a closed state; omitted while IN_PROGRESS.
+ format: date-time
+ type: string
+ message:
+ description: Human-readable message about the workflow status
+ maxLength: 255
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ startTime:
+ description: UTC instant when the workflow execution started.
+ format: date-time
+ type: string
+ status:
+ description: Current status of the workflow
+ enum:
+ - IN_PROGRESS
+ - COMPLETED
+ - FAILED
+ - CANCELED
+ - TERMINATED
+ - CONTINUED_AS_NEW
+ - TIMED_OUT
+ - UNKNOWN
+ type: string
+ workflowType:
+ description: Workflow type.
+ enum:
+ - CLONE
+ - CUSTOMER_MANAGED_KEY
+ type: string
+ required:
+ - message
+ - requestStatus
+ - status
+ type: object
+ CollectionListResponse:
+ description: Response to list collections request
+ properties:
+ collections:
+ items:
+ $ref: '#/components/schemas/Collection'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CollectionCreateRequest:
+ description: Properties for the collections to be created
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ builtBy:
+ description: organization that built the collection
+ type: string
+ category:
+ enum:
+ - HEALTHCARE
+ - SMART_CITIES
+ - RETAIL
+ - MANUFACTURING
+ - SUPERCOMPUTING
+ - ROBOTICS
+ - AUTOMOTIVE
+ - TELECOMMUNICATIONS
+ - FINANCE
+ - OIL_AND_GAS
+ - NATURAL_LANGUAGE_PROCESSING
+ - AUTOMATIC_SPEECH_RECOGNITION
+ - INTELLIGENT_VIDEO_ANALYTICS
+ - OBJECT_DETECTION
+ - IMAGE_CLASSIFICATION
+ - ANNOTATION
+ - IMAGE_SYNTHESIS
+ - MACHINE_LEARNING
+ - DEEP_LEARNING
+ - INFRASTRUCTURE
+ - HIGH_PERFORMANCE_COMPUTING
+ - WINDOWS_RTX_ACCELERATED_MODELS
+ - BEGINNER
+ - ADVANCED
+ type: string
+ description:
+ description: Description of the collection
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ name:
+ description: Unique name of the collection
+ maxLength: 128
+ minLength: 1
+ pattern: ^[a-z][a-z\d._-]*$
+ type: string
+ ownerName:
+ description: Name of the user who owns this collection
+ maxLength: 255
+ type: string
+ publisher:
+ description: organization that published the collection
+ maxLength: 255
+ type: string
+ shortDescription:
+ description: Short description of the collection
+ maxLength: 255
+ type: string
+ required:
+ - category
+ - name
+ - shortDescription
+ type: object
+ CollectionResponse:
+ description: Response to create collection request
+ properties:
+ collection:
+ $ref: '#/components/schemas/Collection'
+ description: Collection object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CollectionUpdateRequest:
+ description: Properties for the collection to update
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ builtBy:
+ description: organization that built the collection
+ type: string
+ category:
+ enum:
+ - HEALTHCARE
+ - SMART_CITIES
+ - RETAIL
+ - MANUFACTURING
+ - SUPERCOMPUTING
+ - ROBOTICS
+ - AUTOMOTIVE
+ - TELECOMMUNICATIONS
+ - FINANCE
+ - OIL_AND_GAS
+ - NATURAL_LANGUAGE_PROCESSING
+ - AUTOMATIC_SPEECH_RECOGNITION
+ - INTELLIGENT_VIDEO_ANALYTICS
+ - OBJECT_DETECTION
+ - IMAGE_CLASSIFICATION
+ - ANNOTATION
+ - IMAGE_SYNTHESIS
+ - MACHINE_LEARNING
+ - DEEP_LEARNING
+ - INFRASTRUCTURE
+ - HIGH_PERFORMANCE_COMPUTING
+ - WINDOWS_RTX_ACCELERATED_MODELS
+ - BEGINNER
+ - ADVANCED
+ type: string
+ description:
+ description: Description of the collection
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ ownerName:
+ description: Name of the user who owns this collection
+ maxLength: 255
+ type: string
+ publisher:
+ description: organization that published the collection
+ maxLength: 255
+ type: string
+ shortDescription:
+ description: Short description of the collection
+ maxLength: 255
+ type: string
+ type: object
+ CollectionPatchRequest:
+ description: Properties for the collection to patch
+ properties:
+ operations:
+ items:
+ $ref: '#/components/schemas/CollectionOperation'
+ maxItems: 100
+ maxItems: 100
+ type: array
+ type: object
+ ArtifactListResponse:
+ description: Response to list artifacts request
+ properties:
+ artifacts:
+ items:
+ $ref: '#/components/schemas/Artifact'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ CollectionPublishRequest:
+ description: Request to publish a collection
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ canGuestPull:
+ type: boolean
+ canPublicList:
+ type: boolean
+ isPublic:
+ type: boolean
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ type: object
+ ArtifactVersionListResponse:
+ description: Response to list artifact versions request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactVersions:
+ items:
+ $ref: '#/components/schemas/ArtifactVersion'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactVersionResponse:
+ description: Response to artifact version request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactVersion:
+ $ref: '#/components/schemas/ArtifactVersion'
+ description: Artifact version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactVersionUpdateRequest:
+ description: Version properties to update
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ description:
+ description: Description of the artifact version
+ maxLength: 255
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ type: object
+ ModelListResponse:
+ description: Response to list models request
+ properties:
+ models:
+ items:
+ $ref: '#/components/schemas/Model'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelCreateRequest:
+ description: Properties for the models to be created
+ properties:
+ application:
+ description: Application of the model
+ maxLength: 255
+ type: string
+ bias:
+ description: Text describing bias in the model
+ type: string
+ builtBy:
+ description: organization that built the repository
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the model
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ encryptionKey:
+ $ref: '#/components/schemas/EncryptionKey'
+ description: Customer Managed Key shard configuration for the model
+ explainability:
+ description: Text describing explainability for this model
+ type: string
+ framework:
+ description: Framework used to train this model
+ maxLength: 255
+ type: string
+ hasPlayground:
+ description: indicate if the Model has AI Playground configured
+ type: boolean
+ isPlaygroundEnabled:
+ description: indicate if AI Playground is enabled in the catalog
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ modelFormat:
+ description: Format of the model
+ maxLength: 255
+ type: string
+ name:
+ description: Unique name of the model
+ maxLength: 128
+ minLength: 1
+ pattern: ^[a-z][a-z\d._-]*$
+ type: string
+ ownerName:
+ description: Name of the user who owns this model
+ maxLength: 255
+ type: string
+ precision:
+ description: Precision this model was trained with
+ maxLength: 255
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ type: string
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the repository
+ maxLength: 255
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ type: string
+ shortDescription:
+ description: Short description of the model
+ maxLength: 255
+ type: string
+ required:
+ - framework
+ - name
+ - precision
+ type: object
+ ModelResponse:
+ description: Response to create model request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelUpdateRequest:
+ description: Properties for the model to update
+ properties:
+ application:
+ description: Application of the model
+ maxLength: 255
+ type: string
+ bias:
+ description: Text describing bias in the model
+ type: string
+ builtBy:
+ description: organization that built the repository
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the model
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ explainability:
+ description: Text describing explainability for this model
+ type: string
+ framework:
+ description: Framework used to train this model
+ maxLength: 255
+ type: string
+ hasPlayground:
+ description: indicate if the Model has AI Playground configured
+ type: boolean
+ isPlaygroundEnabled:
+ description: indicate if AI Playground is enabled in the catalog
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ modelFormat:
+ description: Format of the model
+ maxLength: 255
+ type: string
+ ownerName:
+ description: Name of the user who owns this model
+ maxLength: 255
+ type: string
+ precision:
+ description: Precision this model was trained with
+ maxLength: 255
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ type: string
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the repository
+ maxLength: 255
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ type: string
+ shortDescription:
+ description: Short description of the model
+ maxLength: 255
+ type: string
+ type: object
+ ModelVersionListResponse:
+ description: Response to list model versions request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelVersions:
+ items:
+ $ref: '#/components/schemas/ModelVersion'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelVersionCreateRequest:
+ description: Properties for the model version to be created
+ properties:
+ accuracyReached:
+ description: Accuracy this model reached
+ format: float
+ maximum: 100
+ minimum: 0
+ type: number
+ batchSize:
+ description: Batch size this model was trained with
+ format: int64
+ minimum: 0
+ type: integer
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the model version
+ maxLength: 255
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ maxLength: 255
+ type: string
+ id:
+ description: 'Deprecated: Please use version instead. Unique ID of the version'
+ format: int64
+ maximum: 2147483647
+ minimum: 1
+ type: integer
+ memoryFootprint:
+ description: Model size/memory footprint for inference
+ maxLength: 255
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this model trained
+ format: int64
+ minimum: 0
+ type: integer
+ nvcfContainerConfiguration:
+ $ref: '#/components/schemas/NvcfContainerConfiguration'
+ description: NVCF container configuration parameters
+ nvcfDeploymentSpecification:
+ $ref: '#/components/schemas/NvcfDeploymentSpecification'
+ description: NVCF deployment specification
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ ownerName:
+ description: Name of the user who owns this version
+ maxLength: 255
+ type: string
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ pattern: '[^/]+'
+ type: string
+ type: object
+ ModelVersionResponse:
+ description: Response to create a model version request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelVersion:
+ $ref: '#/components/schemas/ModelVersion'
+ description: Model version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ModelVersionUpdateRequest:
+ description: Version properties to update
+ properties:
+ accuracyReached:
+ description: Accuracy this model reached
+ format: float
+ maximum: 100
+ minimum: 0
+ type: number
+ batchSize:
+ description: Batch size this model was trained with
+ format: int64
+ minimum: 0
+ type: integer
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the model version
+ maxLength: 255
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ maxLength: 255
+ type: string
+ memoryFootprint:
+ description: Model size/memory footprint for inference
+ maxLength: 255
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this model trained
+ format: int64
+ minimum: 0
+ type: integer
+ nvcfContainerConfiguration:
+ $ref: '#/components/schemas/NvcfContainerConfiguration'
+ description: NVCF container configuration parameters
+ nvcfDeploymentSpecification:
+ $ref: '#/components/schemas/NvcfDeploymentSpecification'
+ description: NVCF deployment specification
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ ownerName:
+ description: Name of the user who owns this version
+ maxLength: 255
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ type: object
+ ModelVersionFileListResponse:
+ description: Response to list files for model version request
+ properties:
+ model:
+ $ref: '#/components/schemas/Model'
+ description: Model object
+ modelFiles:
+ items:
+ $ref: '#/components/schemas/ModelFile'
+ type: array
+ modelVersion:
+ $ref: '#/components/schemas/ModelVersion'
+ description: Model version object
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeListResponse:
+ description: Response to list recipes request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipes:
+ items:
+ $ref: '#/components/schemas/Recipe'
+ type: array
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeCreateRequest:
+ description: Properties for the recipe to create
+ properties:
+ advanced:
+ description: Text for describing advanced information
+ type: string
+ application:
+ enum:
+ - CLASSIFICATION
+ - OBJECT_DETECTION
+ - SEGMENTATION
+ - TRANSLATION
+ - TEXT_TO_SPEECH
+ - RECOMMENDER
+ - SENTIMENT
+ - NLP
+ - KUBEFLOW_PIPELINE
+ - OTHER
+ - SPEAKER_VERIFICATION
+ - PUNCTUATION_AND_CAPITALIZATION
+ - DIALOG_STATE_TRACKING
+ - SPEAKER_DIARIZATION
+ - SPEAKER_RECOGNITION
+ - SPEECH_SYNTHESIS
+ - VOICE_ACTIVITY_DETECTION
+ - SPEECH_RECOGNITION
+ - LANGUAGE_MODELING
+ - NAMED_ENTITY_RECOGNITION
+ - TEXT_CLASSIFICATION
+ - TEXT_PROCESSING
+ - QUESTION_ANSWERING
+ - CONTENT_GENERATION
+ type: string
+ builtBy:
+ description: organization that built the recipe
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the recipe
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ modelFormat:
+ description: Format of the model this recipe produces
+ maxLength: 255
+ type: string
+ name:
+ description: Unique name of the recipe
+ maxLength: 128
+ minLength: 1
+ pattern: ^[a-z][a-z\d._-]*$
+ type: string
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ precision:
+ enum:
+ - FP16
+ - FP32
+ - INT8
+ - FPBOTH
+ - OTHER
+ - ALL
+ type: string
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the recipe
+ maxLength: 255
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ setup:
+ description: Text describing recipe setup
+ type: string
+ shortDescription:
+ description: Short description of the recipe
+ maxLength: 255
+ type: string
+ trainingFramework:
+ enum:
+ - TensorFlow
+ - Caffe2
+ - CNTK
+ - Torch
+ - PyTorch
+ - MXNet
+ - Keras
+ - Other
+ - TransferLearningToolkit
+ - TensorFlow2
+ type: string
+ required:
+ - application
+ - modelFormat
+ - name
+ - precision
+ - publicDatasetUsed
+ - shortDescription
+ - trainingFramework
+ type: object
+ RecipeResponse:
+ description: Response to recipe request
+ properties:
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeUpdateRequest:
+ description: Properties for the recipe to update
+ properties:
+ advanced:
+ description: Text for describing advanced information
+ type: string
+ application:
+ enum:
+ - CLASSIFICATION
+ - OBJECT_DETECTION
+ - SEGMENTATION
+ - TRANSLATION
+ - TEXT_TO_SPEECH
+ - RECOMMENDER
+ - SENTIMENT
+ - NLP
+ - KUBEFLOW_PIPELINE
+ - OTHER
+ - SPEAKER_VERIFICATION
+ - PUNCTUATION_AND_CAPITALIZATION
+ - DIALOG_STATE_TRACKING
+ - SPEAKER_DIARIZATION
+ - SPEAKER_RECOGNITION
+ - SPEECH_SYNTHESIS
+ - VOICE_ACTIVITY_DETECTION
+ - SPEECH_RECOGNITION
+ - LANGUAGE_MODELING
+ - NAMED_ENTITY_RECOGNITION
+ - TEXT_CLASSIFICATION
+ - TEXT_PROCESSING
+ - QUESTION_ANSWERING
+ - CONTENT_GENERATION
+ type: string
+ builtBy:
+ description: organization that built the recipe
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the recipe
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 64
+ minLength: 2
+ type: string
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ modelFormat:
+ description: Format of the model this recipe produces
+ maxLength: 255
+ type: string
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ precision:
+ enum:
+ - FP16
+ - FP32
+ - INT8
+ - FPBOTH
+ - OTHER
+ - ALL
+ type: string
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the recipe
+ maxLength: 255
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ relatedModels:
+ items:
+ $ref: '#/components/schemas/ModelSimplified'
+ type: array
+ setup:
+ description: Text describing recipe setup
+ type: string
+ shortDescription:
+ description: Short description of the recipe
+ maxLength: 255
+ type: string
+ trainingFramework:
+ enum:
+ - TensorFlow
+ - Caffe2
+ - CNTK
+ - Torch
+ - PyTorch
+ - MXNet
+ - Keras
+ - Other
+ - TransferLearningToolkit
+ - TensorFlow2
+ type: string
+ type: object
+ RecipeVersionListResponse:
+ description: Response to list recipe versions request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeVersions:
+ items:
+ $ref: '#/components/schemas/RecipeVersion'
+ type: array
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeVersionCreateRequest:
+ description: Properties for the recipe version to be created
+ properties:
+ accuracyReached:
+ description: Accuracy this recipe reached
+ format: float
+ maximum: 100
+ minimum: 0
+ type: number
+ batchSize:
+ description: Batch size this recipe was trained with
+ format: int64
+ minimum: 0
+ type: integer
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the recipe version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ maxLength: 255
+ type: string
+ id:
+ description: 'Deprecated: Please use version instead. Unique ID of the version'
+ format: int64
+ maximum: 2147483647
+ minimum: 1
+ type: integer
+ memoryFootprint:
+ description: Recipe size/memory footprint for inference
+ maxLength: 255
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this recipe trained
+ format: int64
+ minimum: 0
+ type: integer
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ releaseNotes:
+ description: Text describing this release
+ type: string
+ setup:
+ description: Text describing recipe setup
+ type: string
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ pattern: '[^/]+'
+ type: string
+ type: object
+ RecipeVersionResponse:
+ description: Response to recipe version request
+ properties:
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeVersion:
+ $ref: '#/components/schemas/RecipeVersion'
+ description: Recipe version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ RecipeVersionUpdateRequest:
+ description: Version properties to update
+ properties:
+ accuracyReached:
+ description: Accuracy this recipe reached
+ format: float
+ maximum: 100
+ minimum: 0
+ type: number
+ batchSize:
+ description: Batch size this recipe was trained with
+ format: int64
+ minimum: 0
+ type: integer
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the recipe version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ maxLength: 255
+ type: string
+ memoryFootprint:
+ description: Recipe size/memory footprint for inference
+ maxLength: 255
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this recipe trained
+ format: int64
+ minimum: 0
+ type: integer
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ releaseNotes:
+ description: Text describing this release
+ type: string
+ setup:
+ description: Text describing recipe setup
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ type: object
+ RecipeVersionFileListResponse:
+ description: Response to list files for recipe version request
+ properties:
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ recipe:
+ $ref: '#/components/schemas/Recipe'
+ description: Recipe object
+ recipeFiles:
+ items:
+ $ref: '#/components/schemas/RecipeFile'
+ type: array
+ recipeVersion:
+ $ref: '#/components/schemas/RecipeVersion'
+ description: Recipe version object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactCreateRequest:
+ description: Properties for the artifact to create
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ bias:
+ description: Text describing bias in the model
+ maxLength: 128000
+ type: string
+ builtBy:
+ description: organization that built the artifact
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the artifact
+ maxLength: 128000
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 128
+ minLength: 2
+ type: string
+ explainability:
+ description: Text describing explainability for this model
+ maxLength: 128000
+ type: string
+ labels:
+ items:
+ maxLength: 255
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ name:
+ description: Unique name of the artifact
+ maxLength: 250
+ minLength: 1
+ pattern: ^[a-z][a-z\d._-]*$
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ maxLength: 128000
+ type: string
+ publisher:
+ description: organization that published the artifact
+ maxLength: 255
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ maxLength: 128000
+ type: string
+ shortDescription:
+ description: Short description of the artifact
+ maxLength: 255
+ type: string
+ required:
+ - name
+ - shortDescription
+ type: object
+ ArtifactResponse:
+ description: Response to artifact request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactUpdateRequest:
+ description: Properties for the artifact to update
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ bias:
+ description: Text describing bias in the model
+ type: string
+ builtBy:
+ description: organization that built the artifact
+ maxLength: 255
+ type: string
+ description:
+ description: Description of the artifact
+ type: string
+ displayName:
+ description: Display name
+ maxLength: 128
+ minLength: 2
+ type: string
+ explainability:
+ description: Text describing explainability for this model
+ type: string
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ labelsV2:
+ items:
+ type: string
+ type: array
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ maxLength: 255
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ type: string
+ publisher:
+ description: organization that published the artifact
+ maxLength: 255
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ type: string
+ shortDescription:
+ description: Short description of the artifact
+ maxLength: 255
+ type: string
+ type: object
+ ArtifactCatalogFlags:
+ description: Artifact Catalog Flags object
+ properties:
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ isListedToPublic:
+ description: Flag indicating if artifact is listed and searchable
+ type: boolean
+ isPublic:
+ description: Determines if this artifact is publicly accessible
+ type: boolean
+ type: object
+ DeploymentParametersListResponse:
+ description: Response to list deployment parameters request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ deploymentParameters:
+ items:
+ $ref: '#/components/schemas/DeploymentParameters'
+ type: array
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ DeploymentParameters:
+ description: Deployment Artifact Parameters object
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ DeploymentParametersUpdateRequest:
+ description: Request to update existing deployment parameters
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ DeploymentParametersCreateRequest:
+ description: Request to create a new deployment parameters
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ AcceptArtifactLicenseRequest:
+ description: Request body to accept an org-scoped artifact license.
+ properties:
+ licenseId:
+ description: License identifier to accept (must match a licenseId from the artifact's published licenseTerms).
+ example: NVIDIA Proprietary
+ maxLength: 256
+ minLength: 1
+ pattern: ^[a-zA-Z0-9][a-zA-Z0-9\s._+()/:'-]*$
+ type: string
+ licenseVersion:
+ description: License version to accept (must match licenseVersion for that license on the artifact).
+ example: 1
+ maxLength: 128
+ minLength: 1
+ pattern: ^[a-zA-Z0-9][a-zA-Z0-9\s._+()/:'-]*$
+ type: string
+ required:
+ - licenseId
+ - licenseVersion
+ type: object
+ UpdateReleaseTypeRequest:
+ description: Request to update release type of an artifact version
+ properties:
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ version:
+ description: Artifact version
+ type: string
+ required:
+ - version
+ type: object
+ ArtifactPublishRequest:
+ description: Request to publish an artifact
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ canGuestPull:
+ type: boolean
+ canPublicList:
+ type: boolean
+ isPublic:
+ type: boolean
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ type: object
+ UpdateArtifactVersionConfigs:
+ description: Request to publish an artifact
+ properties:
+ policy:
+ items:
+ enum:
+ - GOV_READY
+ - FedRAMP
+ type: string
+ type: array
+ type: object
+ DeploymentUrlCreateRequest:
+ description: Request to create a new deployment url
+ properties:
+ container:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ cpu:
+ $ref: '#/components/schemas/DeploymentCpuParameters'
+ description: Deployment CPU Parameters object
+ gpu:
+ $ref: '#/components/schemas/DeploymentGpuParameters'
+ description: Deployment GPU Parameters object
+ memory:
+ $ref: '#/components/schemas/DeploymentMemoryParameters'
+ description: Deployment Memory Parameters object
+ model:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ resource:
+ $ref: '#/components/schemas/DeploymentArtifactParameters'
+ description: Deployment Artifact Parameters object
+ storage:
+ $ref: '#/components/schemas/DeploymentStorageParameters'
+ description: Deployment Storage Parameters object
+ type: object
+ DeploymentUrlResponse:
+ description: Response to create a new deployment url
+ properties:
+ csp:
+ description: Cloud Service Provider name
+ type: string
+ deploymentParameters:
+ $ref: '#/components/schemas/DeploymentParameters'
+ description: Deployment Artifact Parameters object
+ deploymentUrl:
+ description: Deployment URL
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactVersionFileListResponse:
+ description: Response to list files for artifact version request
+ properties:
+ artifact:
+ $ref: '#/components/schemas/Artifact'
+ description: Artifact object
+ artifactFiles:
+ items:
+ $ref: '#/components/schemas/File'
+ type: array
+ artifactVersion:
+ $ref: '#/components/schemas/ArtifactVersion'
+ description: Artifact version object
+ paginationInfo:
+ $ref: '#/components/schemas/PaginationInfo'
+ description: Pagination Information
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ type: object
+ ArtifactDownloadResponse:
+ description: Response body to download a single file of an artifact
+ properties:
+ filepath:
+ description: The filepath of the artifact
+ type: string
+ requestStatus:
+ $ref: '#/components/schemas/RequestStatus'
+ description: Request status information
+ url:
+ description: Presigned url for single file download
+ type: string
+ required:
+ - url
+ type: object
+ AIPlaygroundCreateRequest:
+ description: Request to create a new AI Playground config
+ properties:
+ artifactName:
+ description: Unique name of the model
+ type: string
+ attributes:
+ description: Metadata json string
+ type: string
+ nvcfFunctionId:
+ description: NVCF function id for the model playground
+ type: string
+ nvcfInferencePath:
+ description: NVCF inference path (invocation route) for the model playground
+ type: string
+ openAPISpec:
+ description: OpenAPI specification for this model
+ type: string
+ required:
+ - artifactName
+ - nvcfFunctionId
+ type: object
+ AIPlaygroundResponse:
+ description: Request to fetch an AI Playground config
+ properties:
+ artifactName:
+ description: Unique name of the model
+ type: string
+ artifactType:
+ description: ArtifactTypeEnum of the artifact
+ type: string
+ attributes:
+ description: Metadata json string
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ namespace:
+ description: org/team of the model
+ type: string
+ nvcfFunctionId:
+ description: NVCF function id for the model playground
+ type: string
+ nvcfInferencePath:
+ description: NVCF inference path (invocation route) for the model playground
+ type: string
+ openAPISpec:
+ description: OpenAPI specification for this model
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ AIPlaygroundUpdateRequest:
+ description: Request to update an AI Playground config
+ properties:
+ attributes:
+ description: Metadata json string
+ type: string
+ nvcfFunctionId:
+ description: NVCF function id for the model playground
+ type: string
+ nvcfInferencePath:
+ description: NVCF inference path (invocation route) for the model playground
+ type: string
+ openAPISpec:
+ description: OpenAPI specification for this model
+ type: string
+ type: object
+ KeyItem:
+ description: Key item with ID and create timestamp string
+ properties:
+ created:
+ description: 'The creation timestamp of the key item in ISO-8601 format. Format: YYYY-MM-DDTHH:mm:ss.sssZ.'
+ example: '2025-04-19T22:30:00.123Z'
+ format: regex
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the encryption key
+ maxLength: 255
+ type: string
+ encryptionKeyId:
+ description: The encryption key identifier in UUID format.
+ example: 196afcf4-d6c8-4116-aa25-34a718a14f43
+ format: regex
+ pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
+ type: string
+ required:
+ - created
+ - encryptionKeyId
+ type: object
+ RequestStatus:
+ description: Request status information
+ properties:
+ requestId:
+ description: Request ID
+ type: string
+ serverId:
+ description: Server ID
+ type: string
+ statusCode:
+ description: Describes response status reported by the server.
+ enum:
+ - UNKNOWN
+ - SUCCESS
+ - UNAUTHORIZED
+ - PAYMENT_REQUIRED
+ - FORBIDDEN
+ - TIMEOUT
+ - EXISTS
+ - NOT_FOUND
+ - INTERNAL_ERROR
+ - INVALID_REQUEST
+ - INVALID_REQUEST_VERSION
+ - INVALID_REQUEST_DATA
+ - METHOD_NOT_ALLOWED
+ - CONFLICT
+ - UNPROCESSABLE_ENTITY
+ - TOO_MANY_REQUESTS
+ - INSUFFICIENT_STORAGE
+ - SERVICE_UNAVAILABLE
+ type: string
+ statusDescription:
+ description: Status description
+ type: string
+ type: object
+ ArtifactItem:
+ description: Artifact item with name and description
+ properties:
+ artifactType:
+ description: Artifact type
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ type: string
+ description:
+ description: Description of the artifact
+ type: string
+ displayName:
+ description: Display name of the artifact
+ type: string
+ name:
+ description: Name of the artifact
+ type: string
+ required:
+ - description
+ - name
+ type: object
+ CloneStatus:
+ description: Progress of cloning artifact version files
+ properties:
+ filesCopied:
+ description: Number of files copied
+ format: int64
+ type: integer
+ internalCheckpointStateCleanup:
+ description: 'Internal-only: When the async clone workflow is completed, this field shows if the internal checkpoint files were successfully cleaned up in the storage - CLEAN if no objects remain (cleanup succeeded or unused), NOT_EMPTY if objects remain, ERROR if verification could not be performed. Omitted when not applicable.'
+ enum:
+ - CLEAN
+ - NOT_EMPTY
+ - ERROR
+ type: string
+ percentageFilesCloned:
+ description: Percentage of files cloned
+ format: double
+ type: number
+ sizeCopied:
+ description: Combined file size copied
+ format: int64
+ type: integer
+ totalFiles:
+ description: Total files at source
+ format: int64
+ type: integer
+ totalSize:
+ description: Combined file size at source
+ format: int64
+ type: integer
+ type: object
+ Collection:
+ description: Collection object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ builtBy:
+ description: Organization that built the collection
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ category:
+ enum:
+ - HEALTHCARE
+ - SMART_CITIES
+ - RETAIL
+ - MANUFACTURING
+ - SUPERCOMPUTING
+ - ROBOTICS
+ - AUTOMOTIVE
+ - TELECOMMUNICATIONS
+ - FINANCE
+ - OIL_AND_GAS
+ - NATURAL_LANGUAGE_PROCESSING
+ - AUTOMATIC_SPEECH_RECOGNITION
+ - INTELLIGENT_VIDEO_ANALYTICS
+ - OBJECT_DETECTION
+ - IMAGE_CLASSIFICATION
+ - ANNOTATION
+ - IMAGE_SYNTHESIS
+ - MACHINE_LEARNING
+ - DEEP_LEARNING
+ - INFRASTRUCTURE
+ - HIGH_PERFORMANCE_COMPUTING
+ - WINDOWS_RTX_ACCELERATED_MODELS
+ - BEGINNER
+ - ADVANCED
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the collection
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ isPublic:
+ description: Determines if this collection is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the collection
+ type: string
+ orgName:
+ description: Name of the org that the collection belongs to
+ type: string
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publisher:
+ description: Organization that published this collection
+ type: string
+ shortDescription:
+ description: Short description of the collection
+ type: string
+ size:
+ description: Total count of collection items
+ format: int64
+ type: integer
+ teamName:
+ description: Name of the team that the collection belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ required:
+ - category
+ type: object
+ PaginationInfo:
+ description: Pagination Information
+ properties:
+ index:
+ description: Page index of results
+ format: int32
+ type: integer
+ nextPage:
+ description: Serialized pointer to the next results page. Should be used for fetching next page. Can be empty
+ type: string
+ size:
+ description: Number of results in page
+ format: int32
+ type: integer
+ totalPages:
+ description: Total number of pages available
+ format: int64
+ type: integer
+ totalResults:
+ description: Total number of results available
+ format: int64
+ type: integer
+ type: object
+ ArtifactAttribute:
+ description: Attribute on the artifact
+ properties:
+ key:
+ maxLength: 255
+ pattern: '[a-zA-Z0-9]+'
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ CollectionOperation:
+ description: Collection operation object
+ properties:
+ operation:
+ description: Collection operation
+ maxLength: 255
+ type: string
+ path:
+ description: Path to a collection item in a scoped format
+ maxLength: 255
+ pattern: ^(/(?!/)([\w- %\.(?!\.)])+)+$
+ type: string
+ type: object
+ Artifact:
+ description: Artifact object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ artifactType:
+ description: Artifact type
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ type: string
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ bias:
+ description: Text describing bias in the artifact
+ type: string
+ builtBy:
+ description: Organization that built the helm chart
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the helm chart
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ encryptionKeyId:
+ description: ID of the customer managed encryption key associated with this artifact
+ type: string
+ explainability:
+ description: Text describing the explainability for this artifact
+ type: string
+ hasSignedVersion:
+ description: Indicates if the artifact has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if helm chart is user's favorite
+ type: boolean
+ isPublic:
+ description: Determines if this helm chart is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionId:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ name:
+ description: Unique name of the helm chart
+ type: string
+ orgName:
+ description: Name of the org that the helm chart belongs to
+ type: string
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ privacy:
+ description: Text describing the privacy for this artifact
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publisher:
+ description: Organization that published this helm chart
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the artifact
+ type: string
+ shortDescription:
+ description: Short description of the helm chart
+ type: string
+ teamName:
+ description: Name of the team that the helm chart belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ ArtifactVersion:
+ description: Artifact version object
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ createdByUser:
+ description: Id of the user who created this version
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the version
+ type: string
+ id:
+ description: Unique ID of the version
+ type: string
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the version in bytes
+ format: int64
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ Model:
+ description: Model object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ application:
+ description: Application of the model
+ type: string
+ bias:
+ description: Text describing bias in the model
+ type: string
+ builtBy:
+ description: organization that built the repository
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the model
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ encryptionKeyId:
+ description: ID of the customer managed encryption key associated with this artifact
+ type: string
+ explainability:
+ description: Text describing explainability for this model
+ type: string
+ framework:
+ description: Framework used to train this model
+ type: string
+ hasPlayground:
+ description: indicate if the Model has AI Playground configured
+ type: boolean
+ hasSignedVersion:
+ description: Indicates if the model has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if model is user's favorite
+ type: boolean
+ isPlaygroundEnabled:
+ description: indicate if AI Playground is enabled in the catalog
+ type: boolean
+ isPublic:
+ description: Determines if model is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionGpuModel:
+ description: GPU model and memory used for the latest version
+ type: string
+ latestVersionId:
+ description: 'Deprecated: Please use latestVersionIdStr instead. ID of the latest version'
+ format: int64
+ type: integer
+ latestVersionIdStr:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ modelFormat:
+ description: Format of the model
+ type: string
+ name:
+ description: Unique name of the model
+ type: string
+ orgName:
+ description: Name of the org that the model belongs to
+ type: string
+ ownerName:
+ description: Name of model's owner
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ precision:
+ description: Precision this model was trained with
+ type: string
+ privacy:
+ description: Text describing the privacy for this model
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: organization that published the repository
+ type: string
+ safetyAndSecurity:
+ description: Text for describing the safety and security in the model
+ type: string
+ shortDescription:
+ description: Short description of the model
+ type: string
+ teamName:
+ description: Name of the team that the model belongs to
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ versions:
+ items:
+ type: string
+ type: array
+ type: object
+ EncryptionKey:
+ description: Customer Managed Key shard configuration for the model
+ properties:
+ description:
+ description: Description for a new customer key shard
+ type: string
+ encryptionKeyId:
+ description: ID of the existing customer key shard to use
+ type: string
+ useExistingKey:
+ description: Whether to use an existing customer key shard or should a new one be created
+ type: boolean
+ required:
+ - useExistingKey
+ type: object
+ LicenseMetadata:
+ description: License information for the artifact
+ properties:
+ configuredLicenseTerms:
+ $ref: '#/components/schemas/ConfiguredLicenseTerms'
+ description: License information for the artifact
+ governingTerms:
+ description: Comprehensive terms and links related to the license
+ example: GOVERNING HOSTING TERMS: Use of the model is governed by the NVIDIA Open Model Agreement.
+ maxLength: 1000
+ pattern: ^[\s\S]*$
+ type: string
+ licenseId:
+ description: License ID
+ example: NVIDIA proprietary
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ licenseVersion:
+ description: License version ID
+ example: v1.0
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ needsAcceptance:
+ description: Indicator if user needs to accept this license
+ type: boolean
+ required:
+ - governingTerms
+ - licenseId
+ - licenseVersion
+ type: object
+ Dataset:
+ properties:
+ license:
+ description: License of the dataset
+ maxLength: 255
+ type: string
+ link:
+ description: Link to the dataset
+ maxLength: 255
+ type: string
+ name:
+ description: Name of the dataset
+ maxLength: 255
+ type: string
+ type: object
+ ModelVersion:
+ description: Model version object
+ properties:
+ accuracyReached:
+ description: Accuracy this model reached
+ format: float
+ type: number
+ batchSize:
+ description: Batch size this model was trained with
+ format: int64
+ type: integer
+ createdByUser:
+ description: Id of the user who created this model
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the model version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ type: string
+ id:
+ description: 'Deprecated: Please use versionId instead. Unique ID of the version'
+ format: int64
+ type: integer
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ memoryFootprint:
+ description: Model size/memory footprint for inference
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this model trained
+ format: int64
+ type: integer
+ nvcfContainerConfiguration:
+ $ref: '#/components/schemas/NvcfContainerConfiguration'
+ description: NVCF container configuration parameters
+ nvcfDeploymentSpecification:
+ $ref: '#/components/schemas/NvcfDeploymentSpecification'
+ description: NVCF deployment specification
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ ownerName:
+ description: Name of the user who owns this version
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the model in bytes
+ format: int64
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ type: string
+ type: object
+ CustomMetricGroup:
+ description: Defines the group of custom metrics.
+ properties:
+ attributes:
+ items:
+ $ref: '#/components/schemas/CustomMetric'
+ type: array
+ name:
+ maxLength: 255
+ type: string
+ type: object
+ NvcfContainerConfiguration:
+ description: NVCF container configuration parameters
+ properties:
+ apiBodyFormat:
+ description: API body format
+ type: string
+ containerArgs:
+ description: Container arguments
+ type: string
+ containerEnvironment:
+ items:
+ $ref: '#/components/schemas/MetaData'
+ type: array
+ containerImage:
+ description: Container Image
+ type: string
+ healthUri:
+ description: Health URI
+ type: string
+ inferencePort:
+ description: Inference port
+ type: string
+ inferenceUrl:
+ description: Inference url
+ type: string
+ models:
+ items:
+ $ref: '#/components/schemas/NvcfContainerModel'
+ type: array
+ type: object
+ NvcfDeploymentSpecification:
+ description: NVCF deployment specification
+ properties:
+ gpuCount:
+ description: GPU count
+ format: int32
+ type: integer
+ gpuType:
+ description: GPU type
+ type: string
+ instanceType:
+ description: Instance type
+ type: string
+ maxConcurrency:
+ description: Maximum concurrency
+ format: int32
+ type: integer
+ type: object
+ ModelFile:
+ description: Model file object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the model
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sha256_base64:
+ description: Base64 encoded sha256 hash of the artifact file
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ type: object
+ Recipe:
+ description: Recipe object
+ properties:
+ accessType:
+ enum:
+ - LISTED
+ - EXCLUSIVE
+ - NOT_LISTED
+ type: string
+ advanced:
+ description: Text for describing advanced information
+ type: string
+ application:
+ enum:
+ - CLASSIFICATION
+ - OBJECT_DETECTION
+ - SEGMENTATION
+ - TRANSLATION
+ - TEXT_TO_SPEECH
+ - RECOMMENDER
+ - SENTIMENT
+ - NLP
+ - KUBEFLOW_PIPELINE
+ - OTHER
+ - SPEAKER_VERIFICATION
+ - PUNCTUATION_AND_CAPITALIZATION
+ - DIALOG_STATE_TRACKING
+ - SPEAKER_DIARIZATION
+ - SPEAKER_RECOGNITION
+ - SPEECH_SYNTHESIS
+ - VOICE_ACTIVITY_DETECTION
+ - SPEECH_RECOGNITION
+ - LANGUAGE_MODELING
+ - NAMED_ENTITY_RECOGNITION
+ - TEXT_CLASSIFICATION
+ - TEXT_PROCESSING
+ - QUESTION_ANSWERING
+ - CONTENT_GENERATION
+ type: string
+ builtBy:
+ description: Organization that built the recipe
+ type: string
+ canGuestDownload:
+ description: Indicates if a guest user can download
+ type: boolean
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the recipe
+ type: string
+ displayName:
+ description: Display name
+ type: string
+ hasSignedVersion:
+ description: Indicates if the recipe has any signed versions
+ type: boolean
+ isFavourite:
+ description: Flag indicating if recipe is user's favorite
+ type: boolean
+ isPublic:
+ description: Determines if this recipe is publicly accessible
+ type: boolean
+ isReadOnly:
+ description: indicate if current user has read only permissions (deprecated)
+ type: boolean
+ labels:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ latestVersionId:
+ description: 'Deprecated: Please use latestVersionIdStr instead. ID of the latest version'
+ format: int64
+ type: integer
+ latestVersionIdStr:
+ description: ID of the latest version
+ type: string
+ latestVersionSizeInBytes:
+ description: Size of the latest version in bytes
+ format: int64
+ type: integer
+ licenseTerms:
+ items:
+ $ref: '#/components/schemas/LicenseMetadata'
+ type: array
+ logo:
+ description: URL for the logo image
+ type: string
+ modelFormat:
+ description: Format of the model this recipe produces
+ type: string
+ name:
+ description: Unique name of the recipe
+ type: string
+ orgName:
+ description: Name of the org that the recipe belongs to
+ type: string
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ policyLabels:
+ items:
+ type: string
+ type: array
+ precision:
+ enum:
+ - FP16
+ - FP32
+ - INT8
+ - FPBOTH
+ - OTHER
+ - ALL
+ type: string
+ productNames:
+ items:
+ pattern: ^[a-zA-Z]+[a-zA-Z0-9-.+_\s]+
+ type: string
+ type: array
+ publicDatasetUsed:
+ $ref: '#/components/schemas/Dataset'
+ publisher:
+ description: Organization that published this recipe
+ type: string
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ relatedModels:
+ items:
+ $ref: '#/components/schemas/Model'
+ type: array
+ setup:
+ description: Text describing recipe setup
+ type: string
+ shortDescription:
+ description: Short description of the recipe
+ type: string
+ teamName:
+ description: Name of the team that the recipe belongs to
+ type: string
+ trainingFramework:
+ enum:
+ - TensorFlow
+ - Caffe2
+ - CNTK
+ - Torch
+ - PyTorch
+ - MXNet
+ - Keras
+ - Other
+ - TransferLearningToolkit
+ - TensorFlow2
+ type: string
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ ModelSimplified:
+ description: Model object
+ properties:
+ name:
+ description: Unique name of the model
+ type: string
+ orgName:
+ description: Name of the org that the model belongs to
+ type: string
+ teamName:
+ description: Name of the team that the model belongs to
+ type: string
+ required:
+ - name
+ - orgName
+ type: object
+ RecipeVersion:
+ description: Recipe version object
+ properties:
+ accuracyReached:
+ description: Accuracy this recipe reached
+ format: float
+ type: number
+ batchSize:
+ description: Batch size this recipe was trained with
+ format: int64
+ type: integer
+ createdByUser:
+ description: Id of the user who created this recipe
+ type: string
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ customMetrics:
+ items:
+ $ref: '#/components/schemas/CustomMetricGroup'
+ type: array
+ description:
+ description: Description of the recipe version
+ type: string
+ gpuModel:
+ description: GPU model and memory
+ type: string
+ id:
+ description: 'Deprecated: Please use versionId instead. Unique ID of the version'
+ format: int64
+ type: integer
+ isSigned:
+ description: Indicates if the version is signed
+ type: boolean
+ malwareScanDate:
+ description: Scan date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ malwareScanStatus:
+ description: Malware scan status
+ enum:
+ - NOT_SCANNED
+ - IN_PROGRESS
+ - CLEAN
+ - SUSPICIOUS
+ - FAILED
+ - MALICIOUS
+ type: string
+ memoryFootprint:
+ description: recipe size/memory footprint for inference
+ type: string
+ numberOfEpochs:
+ description: Number of epochs this recipe trained
+ format: int64
+ type: integer
+ otherContents:
+ items:
+ $ref: '#/components/schemas/ArtifactAttribute'
+ type: array
+ performance:
+ description: Text describing performance of the recipe results
+ type: string
+ policy:
+ items:
+ type: string
+ type: array
+ quickStartGuide:
+ description: Text with a guide to getting started
+ type: string
+ releaseNotes:
+ description: Text describing this release
+ type: string
+ releaseType:
+ description: Release type enum for the artifact version in the product lifecycle.
+ enum:
+ - BETA
+ - GA
+ - EA
+ - FEATURE
+ - PRODUCTION
+ - LTSB
+ type: string
+ setup:
+ description: Text describing recipe setup
+ type: string
+ status:
+ description: Version status
+ enum:
+ - UPLOAD_PENDING
+ - UPLOAD_COMPLETE
+ type: string
+ storageVersion:
+ description: The storage version i.e. the format the file and their contents are persisted in in object store. Possible values include V1 - for legacy artifact versions with files, V2 - for new artifact versions with blob registry, `` - for artifact versions without any files.
+ type: string
+ totalFileCount:
+ description: Total file count
+ format: int64
+ type: integer
+ totalSizeInBytes:
+ description: Total size of the recipe in bytes
+ format: int64
+ type: integer
+ versionId:
+ description: Unique version id. Please use this instead of 'id'
+ maxLength: 255
+ type: string
+ type: object
+ RecipeFile:
+ description: Recipe file object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the recipe
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sha256_base64:
+ description: Base64 encoded sha256 hash of the artifact file
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ type: object
+ DeploymentArtifactParameters:
+ description: Deployment Artifact Parameters object
+ properties:
+ artifactType:
+ description: Artifact type
+ enum:
+ - MODEL
+ - MODEL_SCRIPT
+ - HELM_CHART
+ - REPOSITORY
+ - COLLECTION
+ - ENDPOINT
+ - BLUEPRINT
+ - PLAYBOOK
+ - AGENT
+ - API
+ - SKILL
+ type: string
+ displayName:
+ description: Display name of the artifact
+ type: string
+ filePath:
+ description: Path to a file in an artifact version
+ type: string
+ name:
+ description: Unique name of the artifact
+ type: string
+ orgName:
+ description: Name of the org that the artifact belongs to
+ type: string
+ teamName:
+ description: Name of the team that the artifact belongs to
+ type: string
+ versionId:
+ description: ID of the version or tag
+ type: string
+ required:
+ - name
+ - orgName
+ type: object
+ DeploymentCpuParameters:
+ description: Deployment CPU Parameters object
+ properties:
+ count:
+ description: Total count of CPUs
+ format: int64
+ type: integer
+ type: object
+ DeploymentGpuParameters:
+ description: Deployment GPU Parameters object
+ properties:
+ count:
+ description: Total count of GPUs
+ format: int64
+ type: integer
+ type:
+ description: GPU Type
+ type: string
+ type: object
+ DeploymentMemoryParameters:
+ description: Deployment Memory Parameters object
+ properties:
+ capacityInGB:
+ description: Capacity in GB
+ format: int64
+ type: integer
+ type: object
+ DeploymentStorageParameters:
+ description: Deployment Storage Parameters object
+ properties:
+ capacityInGB:
+ description: Capacity in GB
+ format: int64
+ type: integer
+ type: object
+ File:
+ description: File object
+ properties:
+ createdDate:
+ description: Creation date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ description:
+ description: Description of the file
+ type: string
+ path:
+ description: Relative file path from the root of the object
+ maxLength: 1023
+ minLength: 1
+ type: string
+ sizeInBytes:
+ description: Size of the file in bytes
+ format: int64
+ minimum: 0
+ type: integer
+ updatedDate:
+ description: Updated date in ISO-8601 format
+ pattern: \d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+Z
+ type: string
+ type: object
+ ConfiguredLicenseTerms:
+ description: License information for the artifact
+ properties:
+ download:
+ $ref: '#/components/schemas/ConfiguredLicenseTerm'
+ description: License information for the artifact
+ hosting:
+ $ref: '#/components/schemas/ConfiguredLicenseTerm'
+ description: License information for the artifact
+ type: object
+ CustomMetric:
+ description: Custom metrics
+ properties:
+ key:
+ maxLength: 255
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ MetaData:
+ properties:
+ key:
+ maxLength: 255
+ type: string
+ value:
+ maxLength: 255
+ type: string
+ type: object
+ NvcfContainerModel:
+ description: Models version object metadata
+ properties:
+ name:
+ description: Model name
+ type: string
+ uri:
+ description: Model URI
+ type: string
+ version:
+ description: Model version
+ type: string
+ type: object
+ ConfiguredLicenseTerm:
+ description: License information for the artifact
+ properties:
+ artifactType:
+ description: Artifact type
+ example: model
+ maxLength: 15
+ pattern: ^[\s\S]*$
+ type: string
+ generatedHtml:
+ description: Generated html
+ example: GOVERNING HOSTING TERMS: ...
+ maxLength: 9999
+ pattern: ^[\s\S]*$
+ type: string
+ tags:
+ items:
+ $ref: '#/components/schemas/LicenseTag'
+ type: array
+ type: object
+ LicenseTag:
+ description: License tag information for individual term
+ properties:
+ category:
+ description: Category of the tag
+ example: terms
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ key:
+ description: Key identifier for the tag
+ example: nv-open-model
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ label:
+ description: License Label
+ example: NVIDIA Open Model Agreement
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ tag:
+ description: License tag name
+ example: Model Agreement
+ maxLength: 100
+ pattern: ^[\s\S]*$
+ type: string
+ url:
+ description: Link to the hosted license
+ example: https://www.nvidia.com/.../nvidia-open-model-agreement/
+ maxLength: 1000
+ pattern: ^[\s\S]*$
+ type: string
+ type: object
+ x-stackQL-resources:
+ encryption_keys:
+ id: nvidia.private_registry.encryption_keys
+ name: encryption_keys
+ title: Encryption Keys
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1encryption-keys/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.encryptionKeys
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1encryption-keys~1{key_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ delete:
+ operation:
+ $ref: '#/paths/~1encryption-keys~1{key_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '202'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1encryption-keys/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.encryptionKeys
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1encryption-keys~1{key_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1encryption-keys~1{key_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '202'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/get'
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/list'
+ insert: []
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/encryption_keys/methods/delete'
+ replace: []
+ workflows:
+ id: nvidia.private_registry.workflows
+ name: workflows
+ title: Workflows
+ methods:
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team}~1workflows~1{workflow_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1workflows~1{workflow_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/workflows/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/workflows/methods/get'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ collections:
+ id: nvidia.private_registry.collections
+ name: collections
+ title: Collections
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1collections/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collections
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1collections/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collection
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collections
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collection
+ request:
+ nativeCasing: kebab
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/collections/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/get'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/collections/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/collections/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/collections/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/collections/methods/delete'
+ replace: []
+ collection_artifacts:
+ id: nvidia.private_registry.collection_artifacts
+ name: collection_artifacts
+ title: Collection Artifacts
+ methods:
+ update_bulk:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_cross_org_team:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1team~1{artifact_team_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_cross_org_team:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1team~1{artifact_team_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_cross_org:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_cross_org:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1artifacts~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ add:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update_bulk_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_cross_org_team_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1team~1{artifact_team_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_cross_org_team_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1team~1{artifact_team_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_cross_org_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_cross_org_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts~1org~1{artifact_org_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1artifacts~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ add_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add_cross_org_team_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add_cross_org_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add_cross_org_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add_cross_org'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/add'
+ update:
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/update_bulk_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/update_bulk'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove_cross_org_team_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove_cross_org_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove_cross_org_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove_cross_org'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_artifacts/methods/remove'
+ replace: []
+ collection_product_shares:
+ id: nvidia.private_registry.collection_product_shares
+ name: collection_product_shares
+ title: Collection Product Shares
+ methods:
+ add:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1collections~1{collection_name}~1share~1product/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1collections~1{collection_name}~1share~1product/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/collection_product_shares/methods/add_by_team'
+ - $ref: '#/components/x-stackQL-resources/collection_product_shares/methods/add'
+ update: []
+ delete: []
+ replace: []
+ helm_chart_versions:
+ id: nvidia.private_registry.helm_chart_versions
+ name: helm_chart_versions
+ title: Helm Chart Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1helm-charts~1{artifact_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get:
+ operation:
+ $ref: '#/paths/~1helm-charts~1{artifact_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersion
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1helm-charts~1{artifact_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1helm-charts~1{artifact_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1helm-charts~1{artifact_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactVersion
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1helm-charts~1{artifact_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/list'
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/helm_chart_versions/methods/update'
+ delete: []
+ replace: []
+ models:
+ id: nvidia.private_registry.models
+ name: models
+ title: Models
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.models
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1models/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.model
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1models~1{model_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.models
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.model
+ request:
+ nativeCasing: kebab
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/models/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/get'
+ - $ref: '#/components/x-stackQL-resources/models/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/models/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/models/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/models/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/models/methods/delete'
+ replace: []
+ model_versions:
+ id: nvidia.private_registry.model_versions
+ name: model_versions
+ title: Model Versions
+ methods:
+ stash:
+ operation:
+ $ref: '#/paths/~1models~1{artifact_name}~1versions~1{version_id}~1stash/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersion
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ stash_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{artifact_name}~1versions~1{version_id}~1stash/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersion
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_versions/methods/update'
+ delete: []
+ replace: []
+ model_encryption_keys:
+ id: nvidia.private_registry.model_encryption_keys
+ name: model_encryption_keys
+ title: Model Encryption Keys
+ methods:
+ delete:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1encryption-key/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '202'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1encryption-key/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '202'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/model_encryption_keys/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_encryption_keys/methods/delete'
+ replace: []
+ model_files:
+ id: nvidia.private_registry.model_files
+ name: model_files
+ title: Model Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1models~1{model_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1models~1{model_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/model_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/model_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ recipes:
+ id: nvidia.private_registry.recipes
+ name: recipes
+ title: Recipes
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1recipes/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1recipes/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/get'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipes/methods/update'
+ delete: []
+ replace: []
+ recipe_versions:
+ id: nvidia.private_registry.recipe_versions
+ name: recipe_versions
+ title: Recipe Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_versions/methods/update'
+ delete: []
+ replace: []
+ recipe_files:
+ id: nvidia.private_registry.recipe_files
+ name: recipe_files
+ title: Recipe Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1recipes~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1recipes~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/recipe_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/recipe_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ repository_associated_models:
+ id: nvidia.private_registry.repository_associated_models
+ name: repository_associated_models
+ title: Repository Associated Models
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1repositories~1{container_name}~1associated-models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_tag:
+ operation:
+ $ref: '#/paths/~1repositories~1{container_name}~1tags~1{container_tag}~1associated-models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1repositories~1{container_name}~1associated-models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_tag_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1repositories~1{container_name}~1tags~1{container_tag}~1associated-models/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.modelVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/repository_associated_models/methods/list_by_tag_by_team'
+ - $ref: '#/components/x-stackQL-resources/repository_associated_models/methods/list_by_tag'
+ - $ref: '#/components/x-stackQL-resources/repository_associated_models/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/repository_associated_models/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ resources:
+ id: nvidia.private_registry.resources
+ name: resources
+ title: Resources
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1resources/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1resources/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipes
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipe
+ request:
+ nativeCasing: kebab
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resources/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/get'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/resources/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/resources/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/resources/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/resources/methods/delete'
+ replace: []
+ resource_versions:
+ id: nvidia.private_registry.resource_versions
+ name: resource_versions
+ title: Resource Versions
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}~1versions/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersions
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}~1versions/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}~1versions~1{version_id}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeVersion
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}~1versions~1{version_id}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/get'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_versions/methods/update'
+ delete: []
+ replace: []
+ resource_files:
+ id: nvidia.private_registry.resource_files
+ name: resource_files
+ title: Resource Files
+ methods:
+ list:
+ operation:
+ $ref: '#/paths/~1resources~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1resources~1{recipe_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.recipeFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/resource_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/resource_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifacts:
+ id: nvidia.private_registry.artifacts
+ name: artifacts
+ title: Artifacts
+ methods:
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifact
+ request:
+ nativeCasing: kebab
+ replace_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sync_release_type_labels_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1collections~1sync-release-type-labels/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ set_release_type_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1release-type/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ set_terms_of_service_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1terms-of-service/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1{artifact_type}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifacts
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifact
+ request:
+ nativeCasing: kebab
+ replace:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sync_release_type_labels:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1collections~1sync-release-type-labels/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ set_release_type:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1release-type/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ set_terms_of_service:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1terms-of-service/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ malware_scan_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1malware-scan/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ purge_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1purge/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ malware_scan:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1malware-scan/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ purge:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1purge/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/get'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/delete'
+ replace:
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/replace_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifacts/methods/replace'
+ artifact_catalog_flags:
+ id: nvidia.private_registry.artifact_catalog_flags
+ name: artifact_catalog_flags
+ title: Artifact Catalog Flags
+ methods:
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1catalog~1flags/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1catalog~1flags/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_catalog_flags/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_catalog_flags/methods/get'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_collections:
+ id: nvidia.private_registry.artifact_collections
+ name: artifact_collections
+ title: Artifact Collections
+ methods:
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1collections/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collections
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1collections/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.collections
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_collections/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_collections/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_deployment_params:
+ id: nvidia.private_registry.artifact_deployment_params
+ name: artifact_deployment_params
+ title: Artifact Deployment Params
+ methods:
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1deployments~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.deploymentParameters
+ request:
+ nativeCasing: kebab
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ list:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1deployments~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.deploymentParameters
+ request:
+ nativeCasing: kebab
+ get:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ delete:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1deployments~1{csp_name}~1params/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/get'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/list'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployment_params/methods/delete'
+ replace: []
+ license_acceptances:
+ id: nvidia.private_registry.license_acceptances
+ name: license_acceptances
+ title: License Acceptances
+ methods:
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1license~1acceptance/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1license~1acceptance/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/license_acceptances/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/license_acceptances/methods/create'
+ update: []
+ delete: []
+ replace: []
+ artifact_shares:
+ id: nvidia.private_registry.artifact_shares
+ name: artifact_shares
+ title: Artifact Shares
+ methods:
+ add_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1share/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ remove_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1share/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1share/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: kebab
+ remove:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1share/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifact_shares/methods/add_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_shares/methods/add'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifact_shares/methods/remove_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_shares/methods/remove'
+ replace: []
+ artifact_product_shares:
+ id: nvidia.private_registry.artifact_product_shares
+ name: artifact_product_shares
+ title: Artifact Product Shares
+ methods:
+ add_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1share~1product/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1share~1product/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ add:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1share~1product/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ remove:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1share~1product/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifact_product_shares/methods/add_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_product_shares/methods/add'
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifact_product_shares/methods/remove_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_product_shares/methods/remove'
+ replace: []
+ artifact_versions:
+ id: nvidia.private_registry.artifact_versions
+ name: artifact_versions
+ title: Artifact Versions
+ methods:
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update: []
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifact_versions/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_versions/methods/delete'
+ replace: []
+ artifact_version_configs:
+ id: nvidia.private_registry.artifact_version_configs
+ name: artifact_version_configs
+ title: Artifact Version Configs
+ methods:
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1configs/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1configs/patch'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update:
+ - $ref: '#/components/x-stackQL-resources/artifact_version_configs/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_version_configs/methods/update'
+ delete: []
+ replace: []
+ artifact_deployments:
+ id: nvidia.private_registry.artifact_deployments
+ name: artifact_deployments
+ title: Artifact Deployments
+ methods:
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1deployments~1{csp_name}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1deployments~1{csp_name}/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifact_deployments/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_deployments/methods/create'
+ update: []
+ delete: []
+ replace: []
+ artifact_files:
+ id: nvidia.private_registry.artifact_files
+ name: artifact_files
+ title: Artifact Files
+ methods:
+ list_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ list:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1files/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ objectKey: $.artifactFiles
+ request:
+ nativeCasing: kebab
+ config:
+ pagination:
+ algorithm: page_number
+ requestToken:
+ key: page-number
+ location: query
+ responseToken:
+ key: $.paginationInfo.index
+ location: body
+ responseTerminator:
+ key: $.paginationInfo.totalPages
+ location: body
+ queryParamPushdown:
+ top:
+ paramName: page-size
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_files/methods/list_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_files/methods/list'
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_signatures:
+ id: nvidia.private_registry.artifact_signatures
+ name: artifact_signatures
+ title: Artifact Signatures
+ methods:
+ set_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1signature/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ set:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1versions~1{version_id}~1signature/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select: []
+ insert: []
+ update: []
+ delete: []
+ replace: []
+ artifact_specs:
+ id: nvidia.private_registry.artifact_specs
+ name: artifact_specs
+ title: Artifact Specs
+ methods:
+ create_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1spec/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1spec/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update_by_team:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1spec/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete_by_team:
+ operation:
+ $ref: '#/paths/~1team~1{team_name}~1{artifact_type}~1{artifact_name}~1spec/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ create:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1spec/post'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ get:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1spec/get'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ update:
+ config:
+ requestBodyTranslate:
+ algorithm: naive
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1spec/put'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ delete:
+ operation:
+ $ref: '#/paths/~1{artifact_type}~1{artifact_name}~1spec/delete'
+ response:
+ mediaType: application/json
+ openAPIDocKey: '200'
+ request:
+ nativeCasing: camel
+ sqlVerbs:
+ select:
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/get_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/get'
+ insert:
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/create_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/create'
+ update:
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/update_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/update'
+ delete:
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/delete_by_team'
+ - $ref: '#/components/x-stackQL-resources/artifact_specs/methods/delete'
+ replace: []
+servers:
+ - url: https://api.ngc.nvidia.com