Skip to main content
API docs by Redocly

ingest-config (2.0)

Download OpenAPI specification:Download

Manages data store configuration and enables invocation of robolog ingestion into the Model-Prime platform.

oauth

Revokes the OAuth Consent for your user.

Revokes the OAuth consent token associated with your user, preventing Model-Prime from accessing your data stores and from receiving upload notifications for those stores. Once it is revoked, the OAuth Consent will need to be removed from the provider before you can re-authenticate with Model-Prime. To do so, navigate to https://myaccount.google.com/connections and remove the connection to Model-Prime.

Responses

Returns the list of OAuth Consent statuses for your account.

Returns the OAuth Consent status for your account for all OAuth providers.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Creates an OAuth Consent request for your user.

Creates an OAuth Consent request for your user account and redirects you to the OAuth Consent page for the data store provider. Returns an error if you have already granted OAuth Consent for the provider. The consent allows Model-Prime to access your data store and to receive upload notifications from the store.

Responses

Response samples

Content type
application/json
{}

store

Lists all active data stores registered by your organization.

query Parameters
page_number
integer
Default: 1

pagination page

page_size
integer
Default: 10

pagination page size

show_deactivated
boolean

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "items": [
    ]
}

Creates a data store configuration for automated ingestion.

Creates a data store configuration used by the Model-Prime platform during automated ingestion.

Request Body schema: application/json
required

Configuration parameters identifying the data store and the type of logs to be ingested.

log_extension
required
string
log_type
required
string (LogType)
Enum: "UNKNOWN" "ROS2Bag" "ROS2BagMCAP" "ROS1Bag" "InfluxDB" "ULOG" "JSON"
required
any

Responses

Request samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    }
}

Response samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    },
  • "oauthRedirectUrl": "https://example.com/oauth",
  • "deactivated_at": "string",
  • "id": "4a336fb5-8aa3-49c5-a6de-c01d2b45c3c3"
}

Deletes the configuration for the specified data store.

Deletes the configuration for the specified data store. If hard is set to true, the configuration is completely removed from the Model-Prime platform. If hard is set to false, the configuration is deactivated and may be reactivated with the PUT endpoint.

path Parameters
id
required
string <uuid>

The store ID uniquely identifying the resource.

query Parameters
hard
boolean
Default: false

Set this to true to permanently delete the resource instead of deactivating it.

Responses

Response samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    },
  • "oauthRedirectUrl": "https://example.com/oauth",
  • "deactivated_at": "string",
  • "id": "4a336fb5-8aa3-49c5-a6de-c01d2b45c3c3"
}

Returns the specified active data store.

path Parameters
id
required
string <uuid>

The store ID uniquely identifying the resource.

Responses

Response samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    },
  • "oauthRedirectUrl": "https://example.com/oauth",
  • "deactivated_at": "string",
  • "id": "4a336fb5-8aa3-49c5-a6de-c01d2b45c3c3"
}

Updates the configuration for the specified active data store.

path Parameters
id
required
string <uuid>

The store ID uniquely identifying the resource.

Request Body schema: application/json
required

An object which contains the configuration parameters to update for the specified data store. This includes the LogType enum and the storage configuration.

log_extension
required
string
log_type
required
string (LogType)
Enum: "UNKNOWN" "ROS2Bag" "ROS2BagMCAP" "ROS1Bag" "InfluxDB" "ULOG" "JSON"
required
any

Responses

Request samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    }
}

Response samples

Content type
application/json
{
  • "log_extension": ".yaml",
  • "log_type": "ROS2Bag",
  • "storage_configuration": {
    },
  • "oauthRedirectUrl": "https://example.com/oauth",
  • "deactivated_at": "string",
  • "id": "4a336fb5-8aa3-49c5-a6de-c01d2b45c3c3"
}

ingest

Invokes one-time ingestion of a robolog from the specified data store.

Request Body schema: application/json
required

The data store configuration required to invoke metadata ingestion. storage_principal is an internally used field and should not be supplied for user-initiated ingestion

any
log_type
string (LogType)
Enum: "UNKNOWN" "ROS2Bag" "ROS2BagMCAP" "ROS1Bag" "InfluxDB" "ULOG" "JSON"

Responses

Request samples

Content type
application/json
{
  • "host_config": {
    },
  • "log_type": "ROS2Bag"
}

Response samples

Content type
application/json
{
  • "trace_id": "string"
}