Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Access Red Rover data via this REST API for Organizations that have granted you access. # Authentication The API is protected by HTTP Basic Authentication. Each application that connects to the API has a unique username and password that it must supply with every request. This value needs to be supplied as an HTTP Header: `Authorization=BASIC [hash]`. The value of [hash] is the string username:password base64 encoded. Endpoints marked for Basic Auth can be used with the Basic Auth username and password that you have been assigned. # API Information ## Api Key Each Red Rover organization that has authorized your application has a unique API Key for your application. To retrieve the API Key, you can use the Organization endpoint (`api/v1/organization`) which returns an ApiKey uniquely used for each Organization. You must supply this as an HTTP Header when accessing that organization: `apiKey=[apiKey]`. The domains that require this `ApiKey` header are labeled as 'Requires an ApiKey'. ## Identifier Where an `Identifier` can be specified in the route, you may either supply the Red Rover Id of the object (numeric) or the External Id (alpha-numeric). When specifying an External Id, you will need to prepend the External Id with the pike character`|` (e.g. `|ABC123`). Please note that this is only the case when the External Id is within the route. If the External Id is contained within the body of the request, do not append the pike character. # noqa: E501

Metadata

Release files for redrover-api 1.10.1.dev660

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for redrover-api 1.10.1.dev660
File Size Uploaded Provenance
redrover-api-1.10.1.dev660.tar.gz 138.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for redrover-api 1.10.1.dev660
File Interpreter ABI Platform
redrover_api-1.10.1.dev660-py3-none-any.whl Python 3 none any Details

Total release size: 662.9 kB

Release files / redrover-api-1.10.1.dev660.tar.gz

Download URL redrover-api-1.10.1.dev660.tar.gz
Size 138.2 kB
Tags Source
SHA-256 checksum
How to use checksums
9bc46a44422fcb918170785a3f4c59d0440523979737430b46ae028a2e1148f4
BLAKE2b-256 checksum
How to use checksums
10c8edd7c141229f0537c2ff7ff0052cb112d755c9bbb1ebde126f3de8c1a101
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / redrover_api-1.10.1.dev660-py3-none-any.whl

Download URL redrover_api-1.10.1.dev660-py3-none-any.whl
Size 524.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2056c5a6d1d46e3185fd89035f33bd150d45ce9b095d91298f3a678b4dabcf0f
BLAKE2b-256 checksum
How to use checksums
c83672a979029ba0a24773373164b9eaad504974c526e958184ca1b5e20c7773
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.7

Security for redrover-api 1.10.1.dev660

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page