Jump to

• Request
• Response

List all deployments of an Agent.

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/agents/{agentKey}/deployments

Returns a list of deployments of an agent.

Request

Path Parameters

• agentKey(required): string
  The UUID of the Agent
• aiDataPlatformId(required): string
  Minimum Length: 1

  Maximum Length: 500

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  Minimum Length: 1

  Maximum Length: 200

  The key of the Workspace

Query Parameters

• computeKey: array[string]
  Compute key.
• displayName: string
  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• displayNameContains: string
  Maximum Length: 1000

  A filter to return only resources that have a display name containing the text provided.
• lifecycleState: array[string]
  Collection Format: multi

  A filter to return only resources whose value matches the given lifecycleState.

  • Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ]

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Maximum Length: 1024

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]
• timeCreatedGreaterThanOrEqualTo: string(date-time)
  Fetch objects from repository that were created after or at the exact timestamp provided in parameter
• timeCreatedLessThanOrEqualTo: string(date-time)
  Fetch objects from repository that were created before or at the exact timestamp provided in parameter.

Header Parameters

• opc-request-id: string
  Maximum Length: 255

  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful listing.

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : AgentDeploymentCollection

Type: object

Result of listing agent deployments.

Show Source

• items(required): array items
  List of agent deployments.

{
    "type":"object",
    "description":"Result of listing agent deployments.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of agent deployments.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/AgentDeploymentSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of agent deployments.

Show Source

• Array of: object AgentDeploymentSummary
  Agent deployment summary.

{
    "description":"List of agent deployments.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/AgentDeploymentSummary"
    }
}

Nested Schema : AgentDeploymentSummary

Type: object

Agent deployment summary.

Show Source

• agentCardUrl: string
  AgentCard base URL.
• agentComputeKey: string
  The Agent Compute Key where client can run or test the agent.
• agentKey: string
  The Agent key for which the session is started.
• createdBy(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the user/principal who created the agent session.
• deploymentType(required): string
  Allowed Values: [ "TEST", "PROD", "CODE" ]

  Type of an agent deployment.
• deploymentVersion(required): string
  Version of agent deployed on compute.
• description: string
  deployment description.
• displayName(required): string
  Display name.
• endpointUrl: string
  The endpointUrl where the client should connect to communicate with the agent.
• key(required): string
  Identifier, generally UUID.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ]

  LifecycleState of an Agent Session or Deployment.
• timeCreated(required): string(date-time)
  The date and time the Agent session was created.

{
    "description":"Agent deployment summary.",
    "type":"object",
    "required":[
        "displayName",
        "key",
        "lifecycleState",
        "deploymentType",
        "deploymentVersion",
        "timeCreated",
        "createdBy"
    ],
    "properties":{
        "displayName":{
            "description":"Display name.",
            "type":"string"
        },
        "description":{
            "description":"deployment description.",
            "type":"string"
        },
        "key":{
            "description":"Identifier, generally UUID.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"LifecycleState of an Agent Session or Deployment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState",
            "enum":[
                "CREATING",
                "ACTIVE",
                "INACTIVE",
                "FAILED",
                "DELETED"
            ]
        },
        "deploymentType":{
            "description":"Type of an agent deployment.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DeploymentType",
            "enum":[
                "TEST",
                "PROD",
                "CODE"
            ]
        },
        "agentComputeKey":{
            "description":"The Agent Compute Key where client can run or test the agent.",
            "type":"string"
        },
        "agentKey":{
            "description":"The Agent key for which the session is started.",
            "type":"string"
        },
        "endpointUrl":{
            "description":"The endpointUrl where the client should connect to communicate with the agent.",
            "type":"string"
        },
        "deploymentVersion":{
            "description":"Version of agent deployed on compute.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the Agent session was created.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The OCID of the user/principal who created the agent session.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "agentCardUrl":{
            "type":"string",
            "description":"AgentCard base URL."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top