---
title: "Read a Flink Artifact"
method: GET
path: "/artifact/v1/flink-artifacts/{id}"
tags: ["Flink Artifacts (artifact/v1)"]
---
# Read a Flink Artifact
`GET /artifact/v1/flink-artifacts/{id}`
[](#section/Versioning/API-Lifecycle-Policy)
Make a request to read a flink artifact.
## Path parameters
- `id` string, required
## Query parameters
- `cloud` string, required — Filter a collection by a string search
- `region` string, required — Filter a collection by a string search
- `environment` string, required — Filter a collection by a string search
## Response `200`
Flink Artifact.
- object — FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. ## The Flink Artifacts Model
- `api_version` 'artifact/v1', required — APIVersion defines the schema version of this representation of a resource.
- `kind` 'FlinkArtifact', required — Kind defines the object this REST resource represents.
- `id` string, required — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `cloud` string, required — Cloud provider where the Flink Artifact archive is uploaded.
- `region` string, required — The Cloud provider region the Flink Artifact archive is uploaded.
- `environment` string, required — Environment the Flink Artifact belongs to.
- `display_name` string, required — Unique name of the Flink Artifact per cloud, region, environment scope.
- `class` string — Java class or alias for the artifact as provided by developer. Deprecated
- `content_format` string — Archive format of the Flink Artifact.
- `description` string — Description of the Flink Artifact.
- `documentation_link` string — Documentation link of the Flink Artifact.
- `runtime_language` string — Runtime language of the Flink Artifact.
- `versions` ArtifactV1FlinkArtifactVersion[] — Versions associated with this Flink Artifact.
- `version` string, required — Version id of the Flink Artifact.
- `release_notes` string — Release Notes of the Flink Artifact version.
- `is_beta` boolean — Flag to specify stability of the version
- `artifact_id` ArtifactV1FlinkArtifact, required — FlinkArtifact objects represent Flink Artifacts on Confluent Cloud. ## The Flink Artifacts Model
- `api_version` 'artifact/v1' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'FlinkArtifact' — Kind defines the object this REST resource represents.
- `id` string — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `cloud` string — Cloud provider where the Flink Artifact archive is uploaded.
- `region` string — The Cloud provider region the Flink Artifact archive is uploaded.
- `environment` string — Environment the Flink Artifact belongs to.
- `display_name` string — Unique name of the Flink Artifact per cloud, region, environment scope.
- `class` string — Java class or alias for the artifact as provided by developer. Deprecated
- `content_format` string — Archive format of the Flink Artifact.
- `description` string — Description of the Flink Artifact.
- `documentation_link` string — Documentation link of the Flink Artifact.
- `runtime_language` string — Runtime language of the Flink Artifact.
- `versions` ArtifactV1FlinkArtifactVersion[] — Versions associated with this Flink Artifact.
- `upload_source` object, required — Request a presigned upload URL for new Flink Artifact. Note that the URL policy expires in one hour. If the policy expires, you can request a new presigned upload URL. ## The Presigned Urls Model
- `api_version` 'artifact.v1/UploadSource' — APIVersion defines the schema version of this representation of a resource.
- `kind` 'PresignedUrl' — Kind defines the object this REST resource represents.
- `id` string — ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object `kinds` or objects of the same `kind` within a different scope/namespace ("space").
- `metadata` object — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
- `self` string, uri, required — Self is a Uniform Resource Locator (URL) at which an object can be addressed. This URL encodes the service location, API version, and other particulars necessary to locate the resource at a point in time
- `resource_name` string, uri — Resource Name is a Uniform Resource Identifier (URI) that is globally unique across space and time. It is represented as a Confluent Resource Name
- `created_at` string, date-time — The date and time at which this object was created. It is represented in RFC3339 format and is in UTC.
- `updated_at` string, date-time — The date and time at which this object was last updated. It is represented in RFC3339 format and is in UTC.
- `deleted_at` string, date-time — The date and time at which this object was (or will be) deleted. It is represented in RFC3339 format and is in UTC.
- `location` string — Location of the Flink Artifact source.
- `upload_id` string — Upload ID returned by the `/presigned-upload-url` API. This field returns an empty string in all responses.
## Other responses
- `400` — Bad Request
- `401` — The request lacks valid authentication credentials for this resource.
- `403` — The access credentials were considered insufficient to grant access
- `404` — Not Found
- `429` — Rate Limit Exceeded
- `500` — Oops, something went wrong!
---
[API](https://skmtc.dev/confluent/apis/confluent-cloud-apis.md) · [All operations](https://skmtc.dev/confluent/apis/confluent-cloud-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluent/confluent-cloud-apis/revisions/a6a73f98a698/schema)