Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/censys/censys-postman

A Postman collection for the Censys Search APIs.
https://github.com/censys/censys-postman

censys postman-collection search

Last synced: about 7 hours ago
JSON representation

A Postman collection for the Censys Search APIs.

Host: GitHub
URL: https://github.com/censys/censys-postman
Owner: censys
License: apache-2.0
Created: 2019-03-31T23:16:45.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2023-03-09T16:06:31.000Z (over 1 year ago)
Last Synced: 2024-03-26T04:50:35.073Z (8 months ago)
Topics: censys, postman-collection, search
Homepage:
Size: 1.21 MB
Stars: 24
Watchers: 23
Forks: 14
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-ip-search-engines - Censys Postman Collection

README

        # Censys Postman

[![Postman Collection](https://img.shields.io/badge/Postman-Collection%20v2.1-orange?logo=postman)](https://github.com/censys/censys-postman)

![GitHub last commit](https://img.shields.io/github/last-commit/censys/censys-postman)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-organge.svg?logo=git&logoColor=organge)](http://makeapullrequest.com)

[![License](https://img.shields.io/github/license/censys/censys-postman?logo=apache)](LICENSE)

Postman collections for the Censys Search APIs ([search.censys.io](https://search.censys.io/)) and Censys Attack Surface Management APIs ([app.censys.io](https://app.censys.io))

## Usage

The Postman Collections in this repo are JSON files containing information about the API calls available from Censys Search and Censys ASM. With these collections, you can use Postman to easily test and develop around Censys' APIs.

### Import Collections

To use these Collections, import them into the Postman app. Postman offers several options for import. Click the **Import** button in the Postman app and choose one of the options in the modal:

- Connect to this code repository through Postman

- Copy the URL of the raw files in this repo

    Search: `https://github.com/censys/censys-postman/blob/main/Censys_Search.postman_collection.json?raw=true`

    ASM: `https://github.com/censys/censys-postman/blob/main/Censys_ASM.postman_collection.json?raw=true`

- Copy and paste the raw text of the Collection files into the modal

![Postman Import Modal](images/postman_import_modal.png)

### Set Up an Environment to Populate Collection Variables

The Censys Collections contain calls that reference variables, particularly API credentials, which are required to authenticate every call. You can specify variables in a Postman Environment to reuse across calls.

#### Censys Search

Create a Censys Search Environment and add the following two variables as keys:

- `CENSYS_API_ID`

- `CENSYS_API_SECRET`

![Create an Environment for Censys Search Variables](images/create_search_env.gif)

Retrieve the values for these variables on the [Censys account](https://search.censys.io/account/api) page of the Search app. If you don't have an account, please [sign up for a free account](https://search.censys.io/register) or [contact Censys sales](https://censys.io/contact-sales).

#### Censys ASM

Create a Censys ASM environment and add the following variable as a key:

- `censysApiKey`

Retrieve the value for your Censys ASM API key from the [Integrations page](https://app.censys.io/integrations) of the Attack Surface Management web app and add it to the environment.

## Resources

- [Censys Homepage](https://censys.io/)

- [Censys Search API Docs](https://search.censys.io/api)

- [Censys ASM API Docs](https://app.censys.io/api-docs)

- [Issue Tracker](https://github.com/censys/censys-postman/issues)

- [Postman Documentation](https://learning.postman.com/docs/getting-started/introduction/)

- [Postman Importing Collections](https://learning.postman.com/docs/getting-started/importing-and-exporting-data/#importing-data-into-postman)

- [Postman Environments](https://learning.postman.com/docs/sending-requests/managing-environments/)

## Contributing

All contributions (no matter how small) are always welcome.

## Authors

- Jose Nazario (@jnazarioCensys)

- Aidan Holland (@thehappydinoa)

- Jessica (@jpsinnott)

## License

This software is licensed under [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

- Copyright (C) 2021 Censys, Inc.