Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

How can I find the actual parameters for API for example "protocol", "Host"?

Francis Luigie Tadeo Acuar
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
June 30, 2024

 

How can I find the actual parameters for API for example what should I input in "protocol", "Host" via JSON. 

 this is the file name: user-management.postman

1 answer

0 votes
Samuel Wilson
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
July 2, 2024

Hello, 

To find the actual parameters for an API, such as what to input for “protocol” and “Host” in a JSON file, you can follow these steps:

Open the Postman Collection: Import the user-management.postman file into Postman. This will give you access to the predefined requests and their configurations.
Inspect the Requests: Look at the details of each request in the collection. Postman will show you the URL, headers, body, and other parameters used in the requests.
Check the Environment Variables: Sometimes, parameters like “protocol” and “Host” are defined as environment variables in Postman. Check the environment settings to see if these variables are set there.
Review the API Documentation: If available, the API documentation will provide detailed information about the required parameters, including “protocol” and “Host”. This documentation is often accessible through the API provider’s website.
Example JSON Configuration:


{
  "protocol": "https",
  "Host": "api.example.com",
  "path": "/user-management",
  "method": "POST",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer your_token_here"
  },
  "body": {
    "username": "exampleUser",
    "password": "examplePassword"
  }
}


Use Postman Console: The Postman console can help you debug and see the actual parameters being sent with each request. Open the console and make a request to see the details.
By following these steps, you should be able to identify the correct parameters for your API requests.

 

 

 

 

 

 

 

 


Best Regards,
samuel898
gm-socrates

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PRODUCT PLAN
STANDARD
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events