Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Application Integration
  • All Products

Table of Contents

Search

  1. Preface
  2. The Application Integration Console
  3. Process Server Configuration
  4. Deployed Assets
  5. Process Schedules
  6. Processes
  7. Process Server Health
  8. Process Metrics
  9. APIs
  10. Connections
  11. Guides
  12. Logs

Monitor

Monitor

Back Next

Deactivating an API

Deactivating an API

If a user uses direct endpoints to run an API, and you want to stop the API usage for a certain period, you can deactivate the API. You can deactivate the APIs, that is, the REST and SOAP endpoints of published processes. If users invoke the deactivated API, a
503 Service Unavailable
 error is displayed.
To deactivate the APIs, perform the following steps:
  1. In Application Integration Console, click
    APIs
     on the left navigation bar.
  2. Select the Cloud Server or a Secure Agent to see the APIs.
  3. Select one or more APIs that you want to deactivate, and click
    Deactivate
    .
    The
    Update API Status
     dialog box appears.
  4. To deactivate an API on the Cloud Server, click
    Deactivate
     to proceed.
    The status of the API is updated to
    Inactive
     on the
    APIs
     page.
  5. To deactivate an API on the Secure Agent, perform one of the following steps:
    • If the process runs only on the selected Secure Agent, click
      Deactivate
       to proceed.
    • If the process runs on more than one Secure Agent in a group, perform one of the following steps:
      • Click
        Deactivate only on the selected Secure Agent
         to proceed with the selected Secure Agent.
      • Click
        Deactivate on all the Secure Agents in the group
         to proceed with the Secure Agent group.
    The status of the API is updated to
    Inactive
     on the
    APIs
     page.
Application Integration also updates the API status on the
Properties Detail
 dialog box of the published process as shown in the following image:
The image shows the API status as inactive on the Properties Detail dialog box.
If the status of the API appears as
Inactive
 on the
Properties Detail
 dialog box, you must activate the API to make the API available for the user.
0 COMMENTS
We’d like to hear from you!