PDS Registry Search API (1.3.0)

Download OpenAPI specification:Download

User's Guide

Registry API enabling advanced search on PDS data and metadata. The API provides end-points to search for bundles, collections and any PDS products with advanced search queries. It also enables to browse the archive hierarchically downward (e.g. collection/s products) or upward (e.g. bundles containing a product).

1. all products

search any classe of product and resolve product's identifiers

search on all PDS data products, including bundles, collections, documentation, context and observational products.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

keywords
Array of string

syntax: keyword=keyword1,keyword2,...

behavior: free text search on title and description (if set q is ignored

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

q
string

syntax: q="vid eq 13.0"

behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like "animal", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T

note: ignored when keyword is present

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products
production server
https://pds.nasa.gov/api/registry/1/products

Response samples

No sample

returns one PDS Product with the identifier selected from all PDS Products, including bundles, collections, data, documentation, context and observational products. See identifier for details on how it determines what is returned.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}

Response samples

No sample

returns one PDS Product with the identifier selected from all PDS Products. See identifier for details on how it determines what is returned.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/latest
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/latest

Response samples

No sample

returns all product versions with the identifier (lid) selected from all PDS Products. See identifier for details on how it determines what is returned. note: if given a lidvid, it will be translated to a lid

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/all
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/all

Response samples

No sample

return a list of all possible searchable metadata fields for products published in the registry

Responses

200

An array of all searchable properties of products in the registry.

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /properties
production server
https://pds.nasa.gov/api/registry/1/properties

Response samples

No sample

2. product references

explore the product hierarchy

returns all of the members of the given lid/lidvid

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/members
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/members

Response samples

No sample

returns all of the members of the given lid/lidvid

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/members/{versions}
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/members/{versions}

Response samples

No sample

returns all of the members of the members of the given lid/lidvid

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/members/members
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/members/members

Response samples

No sample

returns all of the members of the members of the given lid/lidvid

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/members/members/{versions}
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/members/members/{versions}

Response samples

No sample

returns one or more PDS Products that have the given PDS lid/lidvid as a member.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/member-of
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/member-of

Response samples

No sample

returns one or more PDS Products that have the given PDS lid/lidvid as a member.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/member-of/{versions}
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/member-of/{versions}

Response samples

No sample

returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/member-of/member-of
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/member-of/member-of

Response samples

No sample

returns one or more PDS Products that have the given PDS lid/lidvid as a member of its members.

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/member-of/member-of/{versions}
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/member-of/member-of/{versions}

Response samples

No sample

3. by product classes

search by class of product, bundles, collections, ...

returns a list of the available PDS product class at this API. This is not all of the PDS product class available in the database, but simply the names that can be used in the /classes/{class} endpoints.

Responses

200

Successful response is always a JSON list of the available class names

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes
production server
https://pds.nasa.gov/api/registry/1/classes

Response samples

No sample

returns all PDS products of the given PDS product class that meet all given constraints.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

keywords
Array of string

syntax: keyword=keyword1,keyword2,...

behavior: free text search on title and description (if set q is ignored

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

q
string

syntax: q="vid eq 13.0"

behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like "animal", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T

note: ignored when keyword is present

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}
production server
https://pds.nasa.gov/api/registry/1/classes/{class}

Response samples

No sample

4. healthcheck

end-point for evaluating system health

returns payload of system health information. Detection of any fatal issues results in a non-200 response. The primary intention of this endpoint is to provide an accurate assessment of the service to determine if ECS/Fargate should instantiate a new instance of the task.

Responses

200

The system checked out as healthy, returning a JSON payload of results

400

Unsuccessful request

404

Unsuccessful request

418

The system did not check out as healthy, returning a JSON payload of results, including error messages indicating the source(s) of the failure(s)

500

Unsuccessful request

501

Unsuccessful request

get /healthcheck
production server
https://pds.nasa.gov/api/registry/1/healthcheck

Response samples

No sample

5. deprecated

end-points which should not be used anymore

returns one or more PDS Products that are members of the given PDS product class and lid/lidvid.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/members
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/members

Response samples

No sample

returns one or more PDS Products that are members of the given PDS product class and lid/lidvid.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/members/{versions}
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/members/{versions}

Response samples

No sample

returns one or more PDS Products that are the members of the members of the given PDS product class and lid/lidvid.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/members/members
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/members/members

Response samples

No sample

returns one or more PDS Products that are the members of the members of the given PDS product class and lid/lidvid.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/members/members/{versions}
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/members/members/{versions}

Response samples

No sample

returns one or more PDS Products that have the given PDS product class and lid/lidvid as a member.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/member-of
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/member-of

Response samples

No sample

returns one or more PDS Products that have the given PDS product class and lid/lidvid as a member.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/member-of/{versions}
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/member-of/{versions}

Response samples

No sample

returns one or more PDS Products that have the given PDS product class and lid/lidvid as a member of its members.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/member-of/member-of
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/member-of/member-of

Response samples

No sample

returns one or more PDS Products that have the given PDS product class and lid/lidvid as a member of its members.

path Parameters
class
required
string
Enum:"any" "bundles" "collections" "documents" "observationals"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

versions
required
string
Enum:"all" "latest"

syntax: one of the allowable enum values

This is a shortcut for doing a query with ...

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /classes/{class}/{identifier}/member-of/member-of/{versions}
production server
https://pds.nasa.gov/api/registry/1/classes/{class}/{identifier}/member-of/member-of/{versions}

Response samples

No sample

deprecated

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

keywords
Array of string

syntax: keyword=keyword1,keyword2,...

behavior: free text search on title and description (if set q is ignored

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

q
string

syntax: q="vid eq 13.0"

behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like "animal", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T

note: ignored when keyword is present

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles
production server
https://pds.nasa.gov/api/registry/1/bundles

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/all
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/latest
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/latest

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/collections
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/collections

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/collections/all
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/collections/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/collections/latest
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/collections/latest

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /bundles/{identifier}/products
production server
https://pds.nasa.gov/api/registry/1/bundles/{identifier}/products

Response samples

No sample

deprecated

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

keywords
Array of string

syntax: keyword=keyword1,keyword2,...

behavior: free text search on title and description (if set q is ignored

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

q
string

syntax: q="vid eq 13.0"

behavior: query uses eq,ne,gt,ge,lt,le,(,),not,and,or operators. Properties are named as in 'properties' attributes, literals are strings between quotes, like "animal", or numbers. Detailed query specification is available at https://bit.ly/3h3D54T

note: ignored when keyword is present

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections
production server
https://pds.nasa.gov/api/registry/1/collections

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/all
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/latest
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/latest

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/bundles
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/bundles

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/products
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/products

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/products/all
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/products/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /collections/{identifier}/products/latest
production server
https://pds.nasa.gov/api/registry/1/collections/{identifier}/products/latest

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/bundles
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/bundles

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/bundles/all
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/bundles/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/bundles/latest
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/bundles/latest

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/collections
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/collections

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/collections/all
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/collections/all

Response samples

No sample

deprecated

path Parameters
identifier
required
string

syntax: lidvid or lid

behavior (lid): returns one or more items whose lid matches this lid exactly. If the endpoint ends with the identifier or /latest then a signle result is returned and it is the highest version. If the endpoint ends with /all then all versions of the lid are returned.

behavior (lidvid): returns one and only one item whose lidvid matches this lidvid exactly.

note: the current lid/lidvid resolution will match all the lids that start with lid. In other words, it acts like a glob of foobar*. It behavesn this way from first character to the last

note: simple sorting of the lidvid is being done to select the latest from the end of the list. However, the versions 1.0, 2.0, and 13.0 will sort to 1.0, 13.0, and 2.0 so the end of the list may not be the latest.

query Parameters
fields
Array of string

syntax: fields=field1,field2,...

behavior: this parameter and the headder Accept: type determine what content is packaged for the result. While the types application/csv, application/kvp+json, and text/csv return only the fields requesteted, all of the other types have a minimal set of fields that must be returned. Duplicating a minimally required field in this parameter has not effect. The types vnd.nasa.pds.pds4+json and vnd.nasa.pds.pds4+xml have a complete set of fields that must be returned; meaning this parameter does not impact their content. When fields is not used, then the minimal set of fields, or all when minimal is an empty set, is returned.

notes: the blob fields are blocked unless specifically requrested and only for the */csv and application/kvp+csv types.

limit
integer >= 0
Default: 100

syntax: limit=10

behavior: maximum number of matching results returned, for pagination

sort
Array of string

syntax: sort=asc(field0),desc(field1),...

behavior: is this implemented?

start
integer >= 0
Default: 0

syntax: start=12

behavior: offset in matching result list, for pagination

Responses

200

Successful request

400

Unsuccessful request

404

Unsuccessful request

500

Unsuccessful request

501

Unsuccessful request

get /products/{identifier}/collections/latest
production server
https://pds.nasa.gov/api/registry/1/products/{identifier}/collections/latest

Response samples

No sample